ultracart_rest_api_v2_typescript 4.1.0 → 4.1.2

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.1.0
+## ultracart_rest_api_v2_typescript@4.1.2
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.0 --save
+npm install ultracart_rest_api_v2_typescript@4.1.2 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.2 | 03/05/2025 | added ChannelPartnerOrder.use_prior_payment_information_from_order_id |
+| 4.1.1 | 02/28/2025 | auto order pause method |
 | 4.1.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
 | 4.0.245 | 02/20/2025 | automation fix |
 | 4.0.244 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |

package/dist/apis/AutoOrderApi.d.ts

@@ -68,6 +68,11 @@ export interface GetAutoOrdersByQueryRequest {
     sort?: string;
     expand?: string;
 }
+export interface PauseAutoOrderRequest {
+    autoOrderOid: number;
+    autoOrder: AutoOrder;
+    expand?: string;
+}
 export interface UpdateAutoOrderRequest {
     autoOrderOid: number;
     autoOrder: AutoOrder;
@@ -232,6 +237,22 @@ export interface AutoOrderApiInterface {
      * Retrieve auto orders by query
      */
     getAutoOrdersByQuery(requestParameters: GetAutoOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {number} autoOrderOid The auto order oid to pause.
+     * @param {AutoOrder} autoOrder Auto orders to pause
+     * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutoOrderApiInterface
+     */
+    pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+    /**
+     * Completely pause an auto order
+     * Pause auto order
+     */
+    pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order
@@ -351,6 +372,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
      * Retrieve auto orders by query
      */
     getAutoOrdersByQuery(requestParameters: GetAutoOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
+    /**
+     * Completely pause an auto order
+     * Pause auto order
+     */
+    pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+    /**
+     * Completely pause an auto order
+     * Pause auto order
+     */
+    pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
      * Update an auto order on the UltraCart account.
      * Update an auto order

package/dist/apis/AutoOrderApi.js

@@ -653,6 +653,73 @@ var AutoOrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Completely pause an auto order
+     * Pause auto order
+     */
+    AutoOrderApi.prototype.pauseAutoOrderRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
+                            throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling pauseAutoOrder.');
+                        }
+                        if (requestParameters.autoOrder === null || requestParameters.autoOrder === undefined) {
+                            throw new runtime.RequiredError('autoOrder', 'Required parameter requestParameters.autoOrder was null or undefined when calling pauseAutoOrder.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/auto_order/auto_orders/{auto_order_oid}/pause".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.AutoOrderToJSON)(requestParameters.autoOrder),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Completely pause an auto order
+     * Pause auto order
+     */
+    AutoOrderApi.prototype.pauseAutoOrder = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.pauseAutoOrderRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Update an auto order on the UltraCart account.
      * Update an auto order

package/dist/models/ChannelPartnerOrder.d.ts

@@ -569,6 +569,12 @@ export interface ChannelPartnerOrder {
      * @memberof ChannelPartnerOrder
      */
     treat_warnings_as_errors?: boolean;
+    /**
+     * An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.
+     * @type {string}
+     * @memberof ChannelPartnerOrder
+     */
+    use_prior_payment_information_from_order_id?: string;
 }
 /**
  * @export

package/dist/models/ChannelPartnerOrder.js

@@ -149,6 +149,7 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
         'tax_exempt': !(0, runtime_1.exists)(json, 'tax_exempt') ? undefined : json['tax_exempt'],
         'transaction': !(0, runtime_1.exists)(json, 'transaction') ? undefined : (0, ChannelPartnerOrderTransaction_1.ChannelPartnerOrderTransactionFromJSON)(json['transaction']),
         'treat_warnings_as_errors': !(0, runtime_1.exists)(json, 'treat_warnings_as_errors') ? undefined : json['treat_warnings_as_errors'],
+        'use_prior_payment_information_from_order_id': !(0, runtime_1.exists)(json, 'use_prior_payment_information_from_order_id') ? undefined : json['use_prior_payment_information_from_order_id'],
     };
 }
 exports.ChannelPartnerOrderFromJSONTyped = ChannelPartnerOrderFromJSONTyped;
@@ -252,6 +253,7 @@ function ChannelPartnerOrderToJSON(value) {
         'tax_exempt': value.tax_exempt,
         'transaction': (0, ChannelPartnerOrderTransaction_1.ChannelPartnerOrderTransactionToJSON)(value.transaction),
         'treat_warnings_as_errors': value.treat_warnings_as_errors,
+        'use_prior_payment_information_from_order_id': value.use_prior_payment_information_from_order_id,
     };
 }
 exports.ChannelPartnerOrderToJSON = ChannelPartnerOrderToJSON;

package/dist/models/ItemPaymentProcessing.d.ts

@@ -22,7 +22,7 @@ export interface ItemPaymentProcessing {
      */
     block_prepaid?: boolean;
     /**
-     * True if this item should block any refund attempts
+     * True if this item should block any refund attempts, set to false otherwise, null value will not update the field
      * @type {boolean}
      * @memberof ItemPaymentProcessing
      */

package/dist/models/OrderCoupon.d.ts

@@ -40,7 +40,7 @@ export interface OrderCoupon {
      */
     coupon_code?: string;
     /**
-     * True if this coupon is hidde from the customer
+     * True if this coupon is hide from the customer
      * @type {boolean}
      * @memberof OrderCoupon
      */

package/package.json

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

package/src/apis/AutoOrderApi.ts

@@ -106,6 +106,12 @@ export interface GetAutoOrdersByQueryRequest {
     expand?: string;
 }
 
+export interface PauseAutoOrderRequest {
+    autoOrderOid: number;
+    autoOrder: AutoOrder;
+    expand?: string;
+}
+
 export interface UpdateAutoOrderRequest {
     autoOrderOid: number;
     autoOrder: AutoOrder;
@@ -288,6 +294,24 @@ export interface AutoOrderApiInterface {
      */
     getAutoOrdersByQuery(requestParameters: GetAutoOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
 
+    /**
+     * Completely pause an auto order 
+     * @summary Pause auto order
+     * @param {number} autoOrderOid The auto order oid to pause.
+     * @param {AutoOrder} autoOrder Auto orders to pause
+     * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutoOrderApiInterface
+     */
+    pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+
+    /**
+     * Completely pause an auto order 
+     * Pause auto order
+     */
+    pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
+
     /**
      * Update an auto order on the UltraCart account. 
      * @summary Update an auto order
@@ -802,6 +826,58 @@ export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterfa
         return await response.value();
     }
 
+    /**
+     * Completely pause an auto order 
+     * Pause auto order
+     */
+    async pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>> {
+        if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
+            throw new runtime.RequiredError('autoOrderOid','Required parameter requestParameters.autoOrderOid was null or undefined when calling pauseAutoOrder.');
+        }
+
+        if (requestParameters.autoOrder === null || requestParameters.autoOrder === undefined) {
+            throw new runtime.RequiredError('autoOrder','Required parameter requestParameters.autoOrder was null or undefined when calling pauseAutoOrder.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.expand !== undefined) {
+            queryParameters['_expand'] = requestParameters.expand;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["auto_order_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auto_order/auto_orders/{auto_order_oid}/pause`.replace(`{${"auto_order_oid"}}`, encodeURIComponent(String(requestParameters.autoOrderOid))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AutoOrderToJSON(requestParameters.autoOrder),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AutoOrderResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Completely pause an auto order 
+     * Pause auto order
+     */
+    async pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse> {
+        const response = await this.pauseAutoOrderRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update an auto order on the UltraCart account. 
      * Update an auto order

package/src/models/ChannelPartnerOrder.ts

@@ -584,6 +584,12 @@ export interface ChannelPartnerOrder {
      * @memberof ChannelPartnerOrder
      */
     treat_warnings_as_errors?: boolean;
+    /**
+     * An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.
+     * @type {string}
+     * @memberof ChannelPartnerOrder
+     */
+    use_prior_payment_information_from_order_id?: string;
 }
 
 
@@ -727,6 +733,7 @@ export function ChannelPartnerOrderFromJSONTyped(json: any, ignoreDiscriminator:
         'tax_exempt': !exists(json, 'tax_exempt') ? undefined : json['tax_exempt'],
         'transaction': !exists(json, 'transaction') ? undefined : ChannelPartnerOrderTransactionFromJSON(json['transaction']),
         'treat_warnings_as_errors': !exists(json, 'treat_warnings_as_errors') ? undefined : json['treat_warnings_as_errors'],
+        'use_prior_payment_information_from_order_id': !exists(json, 'use_prior_payment_information_from_order_id') ? undefined : json['use_prior_payment_information_from_order_id'],
     };
 }
 
@@ -831,6 +838,7 @@ export function ChannelPartnerOrderToJSON(value?: ChannelPartnerOrder | null): a
         'tax_exempt': value.tax_exempt,
         'transaction': ChannelPartnerOrderTransactionToJSON(value.transaction),
         'treat_warnings_as_errors': value.treat_warnings_as_errors,
+        'use_prior_payment_information_from_order_id': value.use_prior_payment_information_from_order_id,
     };
 }
 

package/src/models/ItemPaymentProcessing.ts

@@ -26,7 +26,7 @@ export interface ItemPaymentProcessing {
      */
     block_prepaid?: boolean;
     /**
-     * True if this item should block any refund attempts
+     * True if this item should block any refund attempts, set to false otherwise, null value will not update the field
      * @type {boolean}
      * @memberof ItemPaymentProcessing
      */

package/src/models/OrderCoupon.ts

@@ -44,7 +44,7 @@ export interface OrderCoupon {
      */
     coupon_code?: string;
     /**
-     * True if this coupon is hidde from the customer
+     * True if this coupon is hide from the customer
      * @type {boolean}
      * @memberof OrderCoupon
      */