ultracart_rest_api_v2_typescript 4.1.120 → 4.1.122

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.
@@ -74,10 +74,12 @@ src/models/AutoOrderItemOption.ts
74
74
  src/models/AutoOrderItemSimpleSchedule.ts
75
75
  src/models/AutoOrderLog.ts
76
76
  src/models/AutoOrderManagement.ts
77
+ src/models/AutoOrderPaymentUpdateRequest.ts
77
78
  src/models/AutoOrderPropertiesUpdateRequest.ts
78
79
  src/models/AutoOrderProperty.ts
79
80
  src/models/AutoOrderQuery.ts
80
81
  src/models/AutoOrderQueryBatch.ts
82
+ src/models/AutoOrderRebillResponse.ts
81
83
  src/models/AutoOrderResponse.ts
82
84
  src/models/AutoOrdersRequest.ts
83
85
  src/models/AutoOrdersResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.120
2
+ ## ultracart_rest_api_v2_typescript@4.1.122
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.120 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.122 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |
89
+ | 4.1.121 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
88
90
  | 4.1.120 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
89
91
  | 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |
90
92
  | 4.1.118 | 07/14/2026 | affiliate - send welcome letter method |
@@ -10,7 +10,11 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
13
+ import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPaymentUpdateRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderRebillResponse, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
14
+ export interface AttemptAutoOrderRebillRequest {
15
+ autoOrderOid: number;
16
+ expand?: string;
17
+ }
14
18
  export interface CancelAutoOrderItemByReferenceOrderIdRequest {
15
19
  referenceOrderId: string;
16
20
  originalItemId: string;
@@ -100,6 +104,11 @@ export interface UpdateAutoOrderItemPropertiesRequest {
100
104
  autoOrderPropertiesUpdateRequest: AutoOrderPropertiesUpdateRequest;
101
105
  expand?: string;
102
106
  }
107
+ export interface UpdateAutoOrderPaymentRequest {
108
+ autoOrderOid: number;
109
+ autoOrderPaymentUpdateRequest: AutoOrderPaymentUpdateRequest;
110
+ expand?: string;
111
+ }
103
112
  export interface UpdateAutoOrderPropertiesRequest {
104
113
  autoOrderOid: number;
105
114
  autoOrderPropertiesUpdateRequest: AutoOrderPropertiesUpdateRequest;
@@ -118,6 +127,21 @@ export interface UpdateAutoOrdersBatchRequest {
118
127
  * @interface AutoOrderApiInterface
119
128
  */
120
129
  export interface AutoOrderApiInterface {
130
+ /**
131
+ * Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
132
+ * @summary Attempt a failed rebill on an auto order
133
+ * @param {number} autoOrderOid The auto order oid to rebill.
134
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ * @memberof AutoOrderApiInterface
138
+ */
139
+ attemptAutoOrderRebillRaw(requestParameters: AttemptAutoOrderRebillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderRebillResponse>>;
140
+ /**
141
+ * Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
142
+ * Attempt a failed rebill on an auto order
143
+ */
144
+ attemptAutoOrderRebill(requestParameters: AttemptAutoOrderRebillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderRebillResponse>;
121
145
  /**
122
146
  * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
123
147
  * @summary Cancel a single item on an auto order
@@ -374,6 +398,22 @@ export interface AutoOrderApiInterface {
374
398
  * Update an auto order item properties
375
399
  */
376
400
  updateAutoOrderItemProperties(requestParameters: UpdateAutoOrderItemPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
401
+ /**
402
+ * Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
403
+ * @summary Update the payment information on an auto order
404
+ * @param {number} autoOrderOid The auto order oid to update payment information on.
405
+ * @param {AutoOrderPaymentUpdateRequest} autoOrderPaymentUpdateRequest Payment information to place on the auto order
406
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
407
+ * @param {*} [options] Override http request option.
408
+ * @throws {RequiredError}
409
+ * @memberof AutoOrderApiInterface
410
+ */
411
+ updateAutoOrderPaymentRaw(requestParameters: UpdateAutoOrderPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderRebillResponse>>;
412
+ /**
413
+ * Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
414
+ * Update the payment information on an auto order
415
+ */
416
+ updateAutoOrderPayment(requestParameters: UpdateAutoOrderPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderRebillResponse>;
377
417
  /**
378
418
  * Update an auto order properties. Returns the auto order based upon expansion
379
419
  * @summary Update an auto order properties
@@ -412,6 +452,16 @@ export interface AutoOrderApiInterface {
412
452
  *
413
453
  */
414
454
  export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterface {
455
+ /**
456
+ * Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
457
+ * Attempt a failed rebill on an auto order
458
+ */
459
+ attemptAutoOrderRebillRaw(requestParameters: AttemptAutoOrderRebillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderRebillResponse>>;
460
+ /**
461
+ * Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
462
+ * Attempt a failed rebill on an auto order
463
+ */
464
+ attemptAutoOrderRebill(requestParameters: AttemptAutoOrderRebillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderRebillResponse>;
415
465
  /**
416
466
  * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
417
467
  * Cancel a single item on an auto order
@@ -562,6 +612,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
562
612
  * Update an auto order item properties
563
613
  */
564
614
  updateAutoOrderItemProperties(requestParameters: UpdateAutoOrderItemPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
615
+ /**
616
+ * Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
617
+ * Update the payment information on an auto order
618
+ */
619
+ updateAutoOrderPaymentRaw(requestParameters: UpdateAutoOrderPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderRebillResponse>>;
620
+ /**
621
+ * Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
622
+ * Update the payment information on an auto order
623
+ */
624
+ updateAutoOrderPayment(requestParameters: UpdateAutoOrderPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderRebillResponse>;
565
625
  /**
566
626
  * Update an auto order properties. Returns the auto order based upon expansion
567
627
  * Update an auto order properties
@@ -75,6 +75,68 @@ var AutoOrderApi = /** @class */ (function (_super) {
75
75
  function AutoOrderApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
80
+ * Attempt a failed rebill on an auto order
81
+ */
82
+ AutoOrderApi.prototype.attemptAutoOrderRebillRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, _a, _b, response;
85
+ return __generator(this, function (_c) {
86
+ switch (_c.label) {
87
+ case 0:
88
+ if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
89
+ throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling attemptAutoOrderRebill.');
90
+ }
91
+ queryParameters = {};
92
+ if (requestParameters.expand !== undefined) {
93
+ queryParameters['_expand'] = requestParameters.expand;
94
+ }
95
+ headerParameters = {};
96
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
97
+ // oauth required
98
+ _a = headerParameters;
99
+ _b = "Authorization";
100
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
101
+ case 1:
102
+ // oauth required
103
+ _a[_b] = _c.sent();
104
+ _c.label = 2;
105
+ case 2:
106
+ if (this.configuration && this.configuration.apiKey) {
107
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
108
+ }
109
+ return [4 /*yield*/, this.request({
110
+ path: "/auto_order/auto_orders/{auto_order_oid}/rebill".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
111
+ method: 'POST',
112
+ headers: headerParameters,
113
+ query: queryParameters,
114
+ }, initOverrides)];
115
+ case 3:
116
+ response = _c.sent();
117
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderRebillResponseFromJSON)(jsonValue); })];
118
+ }
119
+ });
120
+ });
121
+ };
122
+ /**
123
+ * Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
124
+ * Attempt a failed rebill on an auto order
125
+ */
126
+ AutoOrderApi.prototype.attemptAutoOrderRebill = function (requestParameters, initOverrides) {
127
+ return __awaiter(this, void 0, void 0, function () {
128
+ var response;
129
+ return __generator(this, function (_a) {
130
+ switch (_a.label) {
131
+ case 0: return [4 /*yield*/, this.attemptAutoOrderRebillRaw(requestParameters, initOverrides)];
132
+ case 1:
133
+ response = _a.sent();
134
+ return [4 /*yield*/, response.value()];
135
+ case 2: return [2 /*return*/, _a.sent()];
136
+ }
137
+ });
138
+ });
139
+ };
78
140
  /**
79
141
  * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
80
142
  * Cancel a single item on an auto order
@@ -1112,6 +1174,73 @@ var AutoOrderApi = /** @class */ (function (_super) {
1112
1174
  });
1113
1175
  });
1114
1176
  };
1177
+ /**
1178
+ * Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
1179
+ * Update the payment information on an auto order
1180
+ */
1181
+ AutoOrderApi.prototype.updateAutoOrderPaymentRaw = function (requestParameters, initOverrides) {
1182
+ return __awaiter(this, void 0, void 0, function () {
1183
+ var queryParameters, headerParameters, _a, _b, response;
1184
+ return __generator(this, function (_c) {
1185
+ switch (_c.label) {
1186
+ case 0:
1187
+ if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
1188
+ throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling updateAutoOrderPayment.');
1189
+ }
1190
+ if (requestParameters.autoOrderPaymentUpdateRequest === null || requestParameters.autoOrderPaymentUpdateRequest === undefined) {
1191
+ throw new runtime.RequiredError('autoOrderPaymentUpdateRequest', 'Required parameter requestParameters.autoOrderPaymentUpdateRequest was null or undefined when calling updateAutoOrderPayment.');
1192
+ }
1193
+ queryParameters = {};
1194
+ if (requestParameters.expand !== undefined) {
1195
+ queryParameters['_expand'] = requestParameters.expand;
1196
+ }
1197
+ headerParameters = {};
1198
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1199
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1200
+ // oauth required
1201
+ _a = headerParameters;
1202
+ _b = "Authorization";
1203
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
1204
+ case 1:
1205
+ // oauth required
1206
+ _a[_b] = _c.sent();
1207
+ _c.label = 2;
1208
+ case 2:
1209
+ if (this.configuration && this.configuration.apiKey) {
1210
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1211
+ }
1212
+ return [4 /*yield*/, this.request({
1213
+ path: "/auto_order/auto_orders/{auto_order_oid}/payment".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
1214
+ method: 'PUT',
1215
+ headers: headerParameters,
1216
+ query: queryParameters,
1217
+ body: (0, models_1.AutoOrderPaymentUpdateRequestToJSON)(requestParameters.autoOrderPaymentUpdateRequest),
1218
+ }, initOverrides)];
1219
+ case 3:
1220
+ response = _c.sent();
1221
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderRebillResponseFromJSON)(jsonValue); })];
1222
+ }
1223
+ });
1224
+ });
1225
+ };
1226
+ /**
1227
+ * Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
1228
+ * Update the payment information on an auto order
1229
+ */
1230
+ AutoOrderApi.prototype.updateAutoOrderPayment = function (requestParameters, initOverrides) {
1231
+ return __awaiter(this, void 0, void 0, function () {
1232
+ var response;
1233
+ return __generator(this, function (_a) {
1234
+ switch (_a.label) {
1235
+ case 0: return [4 /*yield*/, this.updateAutoOrderPaymentRaw(requestParameters, initOverrides)];
1236
+ case 1:
1237
+ response = _a.sent();
1238
+ return [4 /*yield*/, response.value()];
1239
+ case 2: return [2 /*return*/, _a.sent()];
1240
+ }
1241
+ });
1242
+ });
1243
+ };
1115
1244
  /**
1116
1245
  * Update an auto order properties. Returns the auto order based upon expansion
1117
1246
  * Update an auto order properties
@@ -223,6 +223,7 @@ export interface GetEmailCustomerDispatchLogsRequest {
223
223
  pageNumber?: number;
224
224
  pageSize?: number;
225
225
  scanForward?: boolean;
226
+ includeDetail?: boolean;
226
227
  }
227
228
  export interface GetEmailCustomerEditorUrlRequest {
228
229
  storefrontOid: number;
@@ -389,6 +390,7 @@ export interface GetEmailStepDispatchLogsRequest {
389
390
  until?: string;
390
391
  pageNumber?: number;
391
392
  pageSize?: number;
393
+ includeDetail?: boolean;
392
394
  }
393
395
  export interface GetEmailTemplateRequest {
394
396
  storefrontOid: number;
@@ -1526,6 +1528,7 @@ export interface StorefrontApiInterface {
1526
1528
  * @param {number} [pageNumber]
1527
1529
  * @param {number} [pageSize]
1528
1530
  * @param {boolean} [scanForward]
1531
+ * @param {boolean} [includeDetail]
1529
1532
  * @param {*} [options] Override http request option.
1530
1533
  * @throws {RequiredError}
1531
1534
  * @memberof StorefrontApiInterface
@@ -2090,7 +2093,7 @@ export interface StorefrontApiInterface {
2090
2093
  */
2091
2094
  getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
2092
2095
  /**
2093
- * 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.
2096
+ * 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.
2094
2097
  * @summary Get a paginated, date-boundable dispatch-log feed for a step
2095
2098
  * @param {number} storefrontOid
2096
2099
  * @param {string} commseqUuid
@@ -2099,13 +2102,14 @@ export interface StorefrontApiInterface {
2099
2102
  * @param {string} [until]
2100
2103
  * @param {number} [pageNumber]
2101
2104
  * @param {number} [pageSize]
2105
+ * @param {boolean} [includeDetail]
2102
2106
  * @param {*} [options] Override http request option.
2103
2107
  * @throws {RequiredError}
2104
2108
  * @memberof StorefrontApiInterface
2105
2109
  */
2106
2110
  getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
2107
2111
  /**
2108
- * 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.
2112
+ * 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.
2109
2113
  * Get a paginated, date-boundable dispatch-log feed for a step
2110
2114
  */
2111
2115
  getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
@@ -4194,12 +4198,12 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
4194
4198
  */
4195
4199
  getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
4196
4200
  /**
4197
- * 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.
4201
+ * 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.
4198
4202
  * Get a paginated, date-boundable dispatch-log feed for a step
4199
4203
  */
4200
4204
  getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
4201
4205
  /**
4202
- * 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.
4206
+ * 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.
4203
4207
  * Get a paginated, date-boundable dispatch-log feed for a step
4204
4208
  */
4205
4209
  getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
@@ -3387,6 +3387,9 @@ var StorefrontApi = /** @class */ (function (_super) {
3387
3387
  if (requestParameters.scanForward !== undefined) {
3388
3388
  queryParameters['scanForward'] = requestParameters.scanForward;
3389
3389
  }
3390
+ if (requestParameters.includeDetail !== undefined) {
3391
+ queryParameters['includeDetail'] = requestParameters.includeDetail;
3392
+ }
3390
3393
  headerParameters = {};
3391
3394
  if (this.configuration && this.configuration.apiKey) {
3392
3395
  headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
@@ -5916,7 +5919,7 @@ var StorefrontApi = /** @class */ (function (_super) {
5916
5919
  });
5917
5920
  };
5918
5921
  /**
5919
- * 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.
5922
+ * 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.
5920
5923
  * Get a paginated, date-boundable dispatch-log feed for a step
5921
5924
  */
5922
5925
  StorefrontApi.prototype.getEmailStepDispatchLogsRaw = function (requestParameters, initOverrides) {
@@ -5947,6 +5950,9 @@ var StorefrontApi = /** @class */ (function (_super) {
5947
5950
  if (requestParameters.pageSize !== undefined) {
5948
5951
  queryParameters['pageSize'] = requestParameters.pageSize;
5949
5952
  }
5953
+ if (requestParameters.includeDetail !== undefined) {
5954
+ queryParameters['includeDetail'] = requestParameters.includeDetail;
5955
+ }
5950
5956
  headerParameters = {};
5951
5957
  if (this.configuration && this.configuration.apiKey) {
5952
5958
  headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
@@ -5978,7 +5984,7 @@ var StorefrontApi = /** @class */ (function (_super) {
5978
5984
  });
5979
5985
  };
5980
5986
  /**
5981
- * 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.
5987
+ * 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.
5982
5988
  * Get a paginated, date-boundable dispatch-log feed for a step
5983
5989
  */
5984
5990
  StorefrontApi.prototype.getEmailStepDispatchLogs = function (requestParameters, initOverrides) {
@@ -0,0 +1,73 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AutoOrderPaymentUpdateRequest
16
+ */
17
+ export interface AutoOrderPaymentUpdateRequest {
18
+ /**
19
+ * Attempt to rebill the auto order immediately after the payment information is updated. Defaults to false.
20
+ * @type {boolean}
21
+ * @memberof AutoOrderPaymentUpdateRequest
22
+ */
23
+ attempt_rebill?: boolean;
24
+ /**
25
+ * Card expiration month (1-12)
26
+ * @type {number}
27
+ * @memberof AutoOrderPaymentUpdateRequest
28
+ */
29
+ card_expiration_month?: number;
30
+ /**
31
+ * Card expiration year (four digit)
32
+ * @type {number}
33
+ * @memberof AutoOrderPaymentUpdateRequest
34
+ */
35
+ card_expiration_year?: number;
36
+ /**
37
+ * Hosted field token for the credit card number. Tokens are valid for two hours.
38
+ * @type {string}
39
+ * @memberof AutoOrderPaymentUpdateRequest
40
+ */
41
+ card_number_token?: string;
42
+ /**
43
+ * Credit card type. Optional. When the hosted field token carries the card type, the token wins.
44
+ * @type {string}
45
+ * @memberof AutoOrderPaymentUpdateRequest
46
+ */
47
+ card_type?: AutoOrderPaymentUpdateRequestCardTypeEnum;
48
+ /**
49
+ * Hosted field token for the card verification number (CVV). Required when the order has a vaulted card that must be re-vaulted.
50
+ * @type {string}
51
+ * @memberof AutoOrderPaymentUpdateRequest
52
+ */
53
+ card_verification_number_token?: string;
54
+ }
55
+ /**
56
+ * @export
57
+ */
58
+ export declare const AutoOrderPaymentUpdateRequestCardTypeEnum: {
59
+ readonly Amex: "AMEX";
60
+ readonly DinersClub: "Diners Club";
61
+ readonly Discover: "Discover";
62
+ readonly Jcb: "JCB";
63
+ readonly MasterCard: "MasterCard";
64
+ readonly Visa: "VISA";
65
+ };
66
+ export type AutoOrderPaymentUpdateRequestCardTypeEnum = typeof AutoOrderPaymentUpdateRequestCardTypeEnum[keyof typeof AutoOrderPaymentUpdateRequestCardTypeEnum];
67
+ /**
68
+ * Check if a given object implements the AutoOrderPaymentUpdateRequest interface.
69
+ */
70
+ export declare function instanceOfAutoOrderPaymentUpdateRequest(value: object): boolean;
71
+ export declare function AutoOrderPaymentUpdateRequestFromJSON(json: any): AutoOrderPaymentUpdateRequest;
72
+ export declare function AutoOrderPaymentUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AutoOrderPaymentUpdateRequest;
73
+ export declare function AutoOrderPaymentUpdateRequestToJSON(value?: AutoOrderPaymentUpdateRequest | null): any;
@@ -0,0 +1,71 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AutoOrderPaymentUpdateRequestToJSON = exports.AutoOrderPaymentUpdateRequestFromJSONTyped = exports.AutoOrderPaymentUpdateRequestFromJSON = exports.instanceOfAutoOrderPaymentUpdateRequest = exports.AutoOrderPaymentUpdateRequestCardTypeEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * @export
20
+ */
21
+ exports.AutoOrderPaymentUpdateRequestCardTypeEnum = {
22
+ Amex: 'AMEX',
23
+ DinersClub: 'Diners Club',
24
+ Discover: 'Discover',
25
+ Jcb: 'JCB',
26
+ MasterCard: 'MasterCard',
27
+ Visa: 'VISA'
28
+ };
29
+ /**
30
+ * Check if a given object implements the AutoOrderPaymentUpdateRequest interface.
31
+ */
32
+ function instanceOfAutoOrderPaymentUpdateRequest(value) {
33
+ var isInstance = true;
34
+ return isInstance;
35
+ }
36
+ exports.instanceOfAutoOrderPaymentUpdateRequest = instanceOfAutoOrderPaymentUpdateRequest;
37
+ function AutoOrderPaymentUpdateRequestFromJSON(json) {
38
+ return AutoOrderPaymentUpdateRequestFromJSONTyped(json, false);
39
+ }
40
+ exports.AutoOrderPaymentUpdateRequestFromJSON = AutoOrderPaymentUpdateRequestFromJSON;
41
+ function AutoOrderPaymentUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
42
+ if ((json === undefined) || (json === null)) {
43
+ return json;
44
+ }
45
+ return {
46
+ 'attempt_rebill': !(0, runtime_1.exists)(json, 'attempt_rebill') ? undefined : json['attempt_rebill'],
47
+ 'card_expiration_month': !(0, runtime_1.exists)(json, 'card_expiration_month') ? undefined : json['card_expiration_month'],
48
+ 'card_expiration_year': !(0, runtime_1.exists)(json, 'card_expiration_year') ? undefined : json['card_expiration_year'],
49
+ 'card_number_token': !(0, runtime_1.exists)(json, 'card_number_token') ? undefined : json['card_number_token'],
50
+ 'card_type': !(0, runtime_1.exists)(json, 'card_type') ? undefined : json['card_type'],
51
+ 'card_verification_number_token': !(0, runtime_1.exists)(json, 'card_verification_number_token') ? undefined : json['card_verification_number_token'],
52
+ };
53
+ }
54
+ exports.AutoOrderPaymentUpdateRequestFromJSONTyped = AutoOrderPaymentUpdateRequestFromJSONTyped;
55
+ function AutoOrderPaymentUpdateRequestToJSON(value) {
56
+ if (value === undefined) {
57
+ return undefined;
58
+ }
59
+ if (value === null) {
60
+ return null;
61
+ }
62
+ return {
63
+ 'attempt_rebill': value.attempt_rebill,
64
+ 'card_expiration_month': value.card_expiration_month,
65
+ 'card_expiration_year': value.card_expiration_year,
66
+ 'card_number_token': value.card_number_token,
67
+ 'card_type': value.card_type,
68
+ 'card_verification_number_token': value.card_verification_number_token,
69
+ };
70
+ }
71
+ exports.AutoOrderPaymentUpdateRequestToJSON = AutoOrderPaymentUpdateRequestToJSON;
@@ -0,0 +1,83 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AutoOrder } from './AutoOrder';
13
+ import { ModelError } from './ModelError';
14
+ import { ResponseMetadata } from './ResponseMetadata';
15
+ import { Warning } from './Warning';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface AutoOrderRebillResponse
20
+ */
21
+ export interface AutoOrderRebillResponse {
22
+ /**
23
+ *
24
+ * @type {AutoOrder}
25
+ * @memberof AutoOrderRebillResponse
26
+ */
27
+ auto_order?: AutoOrder;
28
+ /**
29
+ *
30
+ * @type {ModelError}
31
+ * @memberof AutoOrderRebillResponse
32
+ */
33
+ error?: ModelError;
34
+ /**
35
+ * Why the rebill attempt did not succeed
36
+ * @type {string}
37
+ * @memberof AutoOrderRebillResponse
38
+ */
39
+ failure_reason?: string;
40
+ /**
41
+ *
42
+ * @type {ResponseMetadata}
43
+ * @memberof AutoOrderRebillResponse
44
+ */
45
+ metadata?: ResponseMetadata;
46
+ /**
47
+ * True if a rebill was attempted during this call
48
+ * @type {boolean}
49
+ * @memberof AutoOrderRebillResponse
50
+ */
51
+ rebill_attempted?: boolean;
52
+ /**
53
+ * The order id created by a successful rebill
54
+ * @type {string}
55
+ * @memberof AutoOrderRebillResponse
56
+ */
57
+ rebill_order_id?: string;
58
+ /**
59
+ * True if the rebill attempt produced an order
60
+ * @type {boolean}
61
+ * @memberof AutoOrderRebillResponse
62
+ */
63
+ rebill_success?: boolean;
64
+ /**
65
+ * Indicates if API call was successful
66
+ * @type {boolean}
67
+ * @memberof AutoOrderRebillResponse
68
+ */
69
+ success?: boolean;
70
+ /**
71
+ *
72
+ * @type {Warning}
73
+ * @memberof AutoOrderRebillResponse
74
+ */
75
+ warning?: Warning;
76
+ }
77
+ /**
78
+ * Check if a given object implements the AutoOrderRebillResponse interface.
79
+ */
80
+ export declare function instanceOfAutoOrderRebillResponse(value: object): boolean;
81
+ export declare function AutoOrderRebillResponseFromJSON(json: any): AutoOrderRebillResponse;
82
+ export declare function AutoOrderRebillResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AutoOrderRebillResponse;
83
+ export declare function AutoOrderRebillResponseToJSON(value?: AutoOrderRebillResponse | null): any;