ultracart_rest_api_v2_typescript 4.1.99 → 4.1.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.99
2
+ ## ultracart_rest_api_v2_typescript@4.1.100
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.99 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.100 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.100 | 06/05/2026 | webhook log summary filtering |
88
89
  | 4.1.99 | 06/05/2026 | added webhook name and merchant_comments |
89
90
  | 4.1.98 | 06/04/2026 | coupon - new coupon type for amount off items with free shipping |
90
91
  | 4.1.97 | 06/03/2026 | fraud api alpha version |
@@ -23,6 +23,15 @@ export interface GetWebhookLogRequest {
23
23
  }
24
24
  export interface GetWebhookLogSummariesRequest {
25
25
  webhookOid: number;
26
+ requestId?: string;
27
+ beginDate?: string;
28
+ endDate?: string;
29
+ status?: string;
30
+ success?: boolean;
31
+ event?: string;
32
+ orderId?: string;
33
+ request?: string;
34
+ duration?: number;
26
35
  limit?: number;
27
36
  offset?: number;
28
37
  since?: string;
@@ -113,6 +122,15 @@ export interface WebhookApiInterface {
113
122
  * Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
114
123
  * @summary Retrieve the log summaries
115
124
  * @param {number} webhookOid The webhook oid to retrieve log summaries for.
125
+ * @param {string} [requestId] Filter by request id
126
+ * @param {string} [beginDate] Filter to deliveries on or after this date/time
127
+ * @param {string} [endDate] Filter to deliveries on or before this date/time
128
+ * @param {string} [status] Filter by HTTP status code
129
+ * @param {boolean} [success] Filter by success (true) or failure (false)
130
+ * @param {string} [event] Filter by an event name contained in the delivery
131
+ * @param {string} [orderId] Filter by an order id contained in the delivery
132
+ * @param {string} [request] Filter by text contained in the request payload
133
+ * @param {number} [duration] Filter to deliveries that took at least this many milliseconds
116
134
  * @param {number} [limit] The maximum number of records to return on this one API call.
117
135
  * @param {number} [offset] Pagination of the record set. Offset is a zero based index.
118
136
  * @param {string} [since] Fetch log summaries that have been delivered since this date/time.
@@ -325,6 +325,33 @@ var WebhookApi = /** @class */ (function (_super) {
325
325
  throw new runtime.RequiredError('webhookOid', 'Required parameter requestParameters.webhookOid was null or undefined when calling getWebhookLogSummaries.');
326
326
  }
327
327
  queryParameters = {};
328
+ if (requestParameters.requestId !== undefined) {
329
+ queryParameters['requestId'] = requestParameters.requestId;
330
+ }
331
+ if (requestParameters.beginDate !== undefined) {
332
+ queryParameters['beginDate'] = requestParameters.beginDate;
333
+ }
334
+ if (requestParameters.endDate !== undefined) {
335
+ queryParameters['endDate'] = requestParameters.endDate;
336
+ }
337
+ if (requestParameters.status !== undefined) {
338
+ queryParameters['status'] = requestParameters.status;
339
+ }
340
+ if (requestParameters.success !== undefined) {
341
+ queryParameters['success'] = requestParameters.success;
342
+ }
343
+ if (requestParameters.event !== undefined) {
344
+ queryParameters['event'] = requestParameters.event;
345
+ }
346
+ if (requestParameters.orderId !== undefined) {
347
+ queryParameters['orderId'] = requestParameters.orderId;
348
+ }
349
+ if (requestParameters.request !== undefined) {
350
+ queryParameters['request'] = requestParameters.request;
351
+ }
352
+ if (requestParameters.duration !== undefined) {
353
+ queryParameters['duration'] = requestParameters.duration;
354
+ }
328
355
  if (requestParameters.limit !== undefined) {
329
356
  queryParameters['_limit'] = requestParameters.limit;
330
357
  }
@@ -28,6 +28,18 @@ export interface WebhookLog {
28
28
  * @memberof WebhookLog
29
29
  */
30
30
  duration?: number;
31
+ /**
32
+ * Event names contained in this delivery
33
+ * @type {Array<string>}
34
+ * @memberof WebhookLog
35
+ */
36
+ event_names?: Array<string>;
37
+ /**
38
+ * Order ids contained in this delivery
39
+ * @type {Array<string>}
40
+ * @memberof WebhookLog
41
+ */
42
+ order_ids?: Array<string>;
31
43
  /**
32
44
  * Number of milliseconds of delay caused by queuing
33
45
  * @type {number}
@@ -35,6 +35,8 @@ function WebhookLogFromJSONTyped(json, ignoreDiscriminator) {
35
35
  return {
36
36
  'delivery_dts': !(0, runtime_1.exists)(json, 'delivery_dts') ? undefined : json['delivery_dts'],
37
37
  'duration': !(0, runtime_1.exists)(json, 'duration') ? undefined : json['duration'],
38
+ 'event_names': !(0, runtime_1.exists)(json, 'event_names') ? undefined : json['event_names'],
39
+ 'order_ids': !(0, runtime_1.exists)(json, 'order_ids') ? undefined : json['order_ids'],
38
40
  'queue_delay': !(0, runtime_1.exists)(json, 'queue_delay') ? undefined : json['queue_delay'],
39
41
  'request': !(0, runtime_1.exists)(json, 'request') ? undefined : json['request'],
40
42
  'request_headers': !(0, runtime_1.exists)(json, 'request_headers') ? undefined : (json['request_headers'].map(HTTPHeader_1.HTTPHeaderFromJSON)),
@@ -58,6 +60,8 @@ function WebhookLogToJSON(value) {
58
60
  return {
59
61
  'delivery_dts': value.delivery_dts,
60
62
  'duration': value.duration,
63
+ 'event_names': value.event_names,
64
+ 'order_ids': value.order_ids,
61
65
  'queue_delay': value.queue_delay,
62
66
  'request': value.request,
63
67
  'request_headers': value.request_headers === undefined ? undefined : (value.request_headers.map(HTTPHeader_1.HTTPHeaderToJSON)),
@@ -21,12 +21,36 @@ export interface WebhookLogSummary {
21
21
  * @memberof WebhookLogSummary
22
22
  */
23
23
  delivery_dts?: string;
24
+ /**
25
+ * Number of milliseconds to process the notification
26
+ * @type {number}
27
+ * @memberof WebhookLogSummary
28
+ */
29
+ duration?: number;
30
+ /**
31
+ * Event names contained in this delivery
32
+ * @type {Array<string>}
33
+ * @memberof WebhookLogSummary
34
+ */
35
+ event_names?: Array<string>;
36
+ /**
37
+ * Order ids contained in this delivery
38
+ * @type {Array<string>}
39
+ * @memberof WebhookLogSummary
40
+ */
41
+ order_ids?: Array<string>;
24
42
  /**
25
43
  * Request id
26
44
  * @type {string}
27
45
  * @memberof WebhookLogSummary
28
46
  */
29
47
  request_id?: string;
48
+ /**
49
+ * HTTP status code received from the server
50
+ * @type {number}
51
+ * @memberof WebhookLogSummary
52
+ */
53
+ status_code?: number;
30
54
  /**
31
55
  * True if the notification was successful
32
56
  * @type {boolean}
@@ -33,7 +33,11 @@ function WebhookLogSummaryFromJSONTyped(json, ignoreDiscriminator) {
33
33
  }
34
34
  return {
35
35
  'delivery_dts': !(0, runtime_1.exists)(json, 'delivery_dts') ? undefined : json['delivery_dts'],
36
+ 'duration': !(0, runtime_1.exists)(json, 'duration') ? undefined : json['duration'],
37
+ 'event_names': !(0, runtime_1.exists)(json, 'event_names') ? undefined : json['event_names'],
38
+ 'order_ids': !(0, runtime_1.exists)(json, 'order_ids') ? undefined : json['order_ids'],
36
39
  'request_id': !(0, runtime_1.exists)(json, 'request_id') ? undefined : json['request_id'],
40
+ 'status_code': !(0, runtime_1.exists)(json, 'status_code') ? undefined : json['status_code'],
37
41
  'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
38
42
  };
39
43
  }
@@ -47,7 +51,11 @@ function WebhookLogSummaryToJSON(value) {
47
51
  }
48
52
  return {
49
53
  'delivery_dts': value.delivery_dts,
54
+ 'duration': value.duration,
55
+ 'event_names': value.event_names,
56
+ 'order_ids': value.order_ids,
50
57
  'request_id': value.request_id,
58
+ 'status_code': value.status_code,
51
59
  'success': value.success,
52
60
  };
53
61
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.99",
3
+ "version": "4.1.100",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -56,6 +56,15 @@ export interface GetWebhookLogRequest {
56
56
 
57
57
  export interface GetWebhookLogSummariesRequest {
58
58
  webhookOid: number;
59
+ requestId?: string;
60
+ beginDate?: string;
61
+ endDate?: string;
62
+ status?: string;
63
+ success?: boolean;
64
+ event?: string;
65
+ orderId?: string;
66
+ request?: string;
67
+ duration?: number;
59
68
  limit?: number;
60
69
  offset?: number;
61
70
  since?: string;
@@ -159,6 +168,15 @@ export interface WebhookApiInterface {
159
168
  * Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
160
169
  * @summary Retrieve the log summaries
161
170
  * @param {number} webhookOid The webhook oid to retrieve log summaries for.
171
+ * @param {string} [requestId] Filter by request id
172
+ * @param {string} [beginDate] Filter to deliveries on or after this date/time
173
+ * @param {string} [endDate] Filter to deliveries on or before this date/time
174
+ * @param {string} [status] Filter by HTTP status code
175
+ * @param {boolean} [success] Filter by success (true) or failure (false)
176
+ * @param {string} [event] Filter by an event name contained in the delivery
177
+ * @param {string} [orderId] Filter by an order id contained in the delivery
178
+ * @param {string} [request] Filter by text contained in the request payload
179
+ * @param {number} [duration] Filter to deliveries that took at least this many milliseconds
162
180
  * @param {number} [limit] The maximum number of records to return on this one API call.
163
181
  * @param {number} [offset] Pagination of the record set. Offset is a zero based index.
164
182
  * @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 {
429
447
 
430
448
  const queryParameters: any = {};
431
449
 
450
+ if (requestParameters.requestId !== undefined) {
451
+ queryParameters['requestId'] = requestParameters.requestId;
452
+ }
453
+
454
+ if (requestParameters.beginDate !== undefined) {
455
+ queryParameters['beginDate'] = requestParameters.beginDate;
456
+ }
457
+
458
+ if (requestParameters.endDate !== undefined) {
459
+ queryParameters['endDate'] = requestParameters.endDate;
460
+ }
461
+
462
+ if (requestParameters.status !== undefined) {
463
+ queryParameters['status'] = requestParameters.status;
464
+ }
465
+
466
+ if (requestParameters.success !== undefined) {
467
+ queryParameters['success'] = requestParameters.success;
468
+ }
469
+
470
+ if (requestParameters.event !== undefined) {
471
+ queryParameters['event'] = requestParameters.event;
472
+ }
473
+
474
+ if (requestParameters.orderId !== undefined) {
475
+ queryParameters['orderId'] = requestParameters.orderId;
476
+ }
477
+
478
+ if (requestParameters.request !== undefined) {
479
+ queryParameters['request'] = requestParameters.request;
480
+ }
481
+
482
+ if (requestParameters.duration !== undefined) {
483
+ queryParameters['duration'] = requestParameters.duration;
484
+ }
485
+
432
486
  if (requestParameters.limit !== undefined) {
433
487
  queryParameters['_limit'] = requestParameters.limit;
434
488
  }
@@ -38,6 +38,18 @@ export interface WebhookLog {
38
38
  * @memberof WebhookLog
39
39
  */
40
40
  duration?: number;
41
+ /**
42
+ * Event names contained in this delivery
43
+ * @type {Array<string>}
44
+ * @memberof WebhookLog
45
+ */
46
+ event_names?: Array<string>;
47
+ /**
48
+ * Order ids contained in this delivery
49
+ * @type {Array<string>}
50
+ * @memberof WebhookLog
51
+ */
52
+ order_ids?: Array<string>;
41
53
  /**
42
54
  * Number of milliseconds of delay caused by queuing
43
55
  * @type {number}
@@ -123,6 +135,8 @@ export function WebhookLogFromJSONTyped(json: any, ignoreDiscriminator: boolean)
123
135
 
124
136
  'delivery_dts': !exists(json, 'delivery_dts') ? undefined : json['delivery_dts'],
125
137
  'duration': !exists(json, 'duration') ? undefined : json['duration'],
138
+ 'event_names': !exists(json, 'event_names') ? undefined : json['event_names'],
139
+ 'order_ids': !exists(json, 'order_ids') ? undefined : json['order_ids'],
126
140
  'queue_delay': !exists(json, 'queue_delay') ? undefined : json['queue_delay'],
127
141
  'request': !exists(json, 'request') ? undefined : json['request'],
128
142
  '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 {
147
161
 
148
162
  'delivery_dts': value.delivery_dts,
149
163
  'duration': value.duration,
164
+ 'event_names': value.event_names,
165
+ 'order_ids': value.order_ids,
150
166
  'queue_delay': value.queue_delay,
151
167
  'request': value.request,
152
168
  'request_headers': value.request_headers === undefined ? undefined : ((value.request_headers as Array<any>).map(HTTPHeaderToJSON)),
@@ -25,12 +25,36 @@ export interface WebhookLogSummary {
25
25
  * @memberof WebhookLogSummary
26
26
  */
27
27
  delivery_dts?: string;
28
+ /**
29
+ * Number of milliseconds to process the notification
30
+ * @type {number}
31
+ * @memberof WebhookLogSummary
32
+ */
33
+ duration?: number;
34
+ /**
35
+ * Event names contained in this delivery
36
+ * @type {Array<string>}
37
+ * @memberof WebhookLogSummary
38
+ */
39
+ event_names?: Array<string>;
40
+ /**
41
+ * Order ids contained in this delivery
42
+ * @type {Array<string>}
43
+ * @memberof WebhookLogSummary
44
+ */
45
+ order_ids?: Array<string>;
28
46
  /**
29
47
  * Request id
30
48
  * @type {string}
31
49
  * @memberof WebhookLogSummary
32
50
  */
33
51
  request_id?: string;
52
+ /**
53
+ * HTTP status code received from the server
54
+ * @type {number}
55
+ * @memberof WebhookLogSummary
56
+ */
57
+ status_code?: number;
34
58
  /**
35
59
  * True if the notification was successful
36
60
  * @type {boolean}
@@ -61,7 +85,11 @@ export function WebhookLogSummaryFromJSONTyped(json: any, ignoreDiscriminator: b
61
85
  return {
62
86
 
63
87
  'delivery_dts': !exists(json, 'delivery_dts') ? undefined : json['delivery_dts'],
88
+ 'duration': !exists(json, 'duration') ? undefined : json['duration'],
89
+ 'event_names': !exists(json, 'event_names') ? undefined : json['event_names'],
90
+ 'order_ids': !exists(json, 'order_ids') ? undefined : json['order_ids'],
64
91
  'request_id': !exists(json, 'request_id') ? undefined : json['request_id'],
92
+ 'status_code': !exists(json, 'status_code') ? undefined : json['status_code'],
65
93
  'success': !exists(json, 'success') ? undefined : json['success'],
66
94
  };
67
95
  }
@@ -76,7 +104,11 @@ export function WebhookLogSummaryToJSON(value?: WebhookLogSummary | null): any {
76
104
  return {
77
105
 
78
106
  'delivery_dts': value.delivery_dts,
107
+ 'duration': value.duration,
108
+ 'event_names': value.event_names,
109
+ 'order_ids': value.order_ids,
79
110
  'request_id': value.request_id,
111
+ 'status_code': value.status_code,
80
112
  'success': value.success,
81
113
  };
82
114
  }