ultracart_rest_api_v2_typescript 4.0.81-RC → 4.0.82-RC

package/.openapi-generator/FILES

@@ -565,6 +565,7 @@ src/models/OrderProperty.ts
 src/models/OrderQuery.ts
 src/models/OrderQueryBatch.ts
 src/models/OrderQuote.ts
+src/models/OrderRefundableResponse.ts
 src/models/OrderReplacement.ts
 src/models/OrderReplacementItem.ts
 src/models/OrderReplacementResponse.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.81-RC
+## ultracart_rest_api_v2_typescript@4.0.82-RC
 
 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.0.81-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.82-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.82-RC | 11/15/2022 | order api new method is order refundable |
 | 4.0.81-RC | 11/15/2022 | increase order property length to 10k char |
 | 4.0.80-RC | 11/14/2022 | conversations - add allowed values for update agent status |
 | 4.0.79-RC | 11/09/2022 | conversations - add an enum of event typing |

package/dist/apis/OrderApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderFormat, OrderFormatResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
+import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderFormat, OrderFormatResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
 export interface AdjustOrderTotalRequest {
     orderId: string;
     desiredTotal: string;
@@ -99,6 +99,9 @@ export interface InsertOrderRequest {
     order: Order;
     expand?: string;
 }
+export interface IsRefundableOrderRequest {
+    orderId: string;
+}
 export interface ProcessPaymentRequest {
     orderId: string;
     processPaymentRequest: OrderProcessPaymentRequest;
@@ -405,6 +408,20 @@ export interface OrderApiInterface {
      * Insert an order
      */
     insertOrder(requestParameters: InsertOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * Determine if an order can be refunded based upon payment method and age
+     * @summary Determine if an order can be refunded
+     * @param {string} orderId The order id to check for refundable order.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>>;
+    /**
+     * Determine if an order can be refunded based upon payment method and age
+     * Determine if an order can be refunded
+     */
+    isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse>;
     /**
      * Process payment on order
      * @summary Process payment
@@ -680,6 +697,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Insert an order
      */
     insertOrder(requestParameters: InsertOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * Determine if an order can be refunded based upon payment method and age
+     * Determine if an order can be refunded
+     */
+    isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>>;
+    /**
+     * Determine if an order can be refunded based upon payment method and age
+     * Determine if an order can be refunded
+     */
+    isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse>;
     /**
      * Process payment on order
      * Process payment

package/dist/apis/OrderApi.js

@@ -1155,6 +1155,65 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Determine if an order can be refunded based upon payment method and age
+     * Determine if an order can be refunded
+     */
+    OrderApi.prototype.isRefundableOrderRaw = 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.orderId === null || requestParameters.orderId === undefined) {
+                            throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling isRefundableOrder.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["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: "/order/orders/{order_id}/refundable".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderRefundableResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Determine if an order can be refunded based upon payment method and age
+     * Determine if an order can be refunded
+     */
+    OrderApi.prototype.isRefundableOrder = 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.isRefundableOrderRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Process payment on order
      * Process payment

package/dist/models/OrderRefundableResponse.d.ts

@@ -0,0 +1,54 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface OrderRefundableResponse
+ */
+export interface OrderRefundableResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof OrderRefundableResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof OrderRefundableResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Whether the order is refundable or not.
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    refundable?: boolean;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof OrderRefundableResponse
+     */
+    warning?: Warning;
+}
+export declare function OrderRefundableResponseFromJSON(json: any): OrderRefundableResponse;
+export declare function OrderRefundableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderRefundableResponse;
+export declare function OrderRefundableResponseToJSON(value?: OrderRefundableResponse | null): any;

package/dist/models/OrderRefundableResponse.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderRefundableResponseToJSON = exports.OrderRefundableResponseFromJSONTyped = exports.OrderRefundableResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function OrderRefundableResponseFromJSON(json) {
+    return OrderRefundableResponseFromJSONTyped(json, false);
+}
+exports.OrderRefundableResponseFromJSON = OrderRefundableResponseFromJSON;
+function OrderRefundableResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'refundable': !(0, runtime_1.exists)(json, 'refundable') ? undefined : json['refundable'],
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.OrderRefundableResponseFromJSONTyped = OrderRefundableResponseFromJSONTyped;
+function OrderRefundableResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'refundable': value.refundable,
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.OrderRefundableResponseToJSON = OrderRefundableResponseToJSON;

package/dist/models/index.d.ts

@@ -540,6 +540,7 @@ export * from './OrderProperty';
 export * from './OrderQuery';
 export * from './OrderQueryBatch';
 export * from './OrderQuote';
+export * from './OrderRefundableResponse';
 export * from './OrderReplacement';
 export * from './OrderReplacementItem';
 export * from './OrderReplacementResponse';

package/dist/models/index.js

@@ -558,6 +558,7 @@ __exportStar(require("./OrderProperty"), exports);
 __exportStar(require("./OrderQuery"), exports);
 __exportStar(require("./OrderQueryBatch"), exports);
 __exportStar(require("./OrderQuote"), exports);
+__exportStar(require("./OrderRefundableResponse"), exports);
 __exportStar(require("./OrderReplacement"), exports);
 __exportStar(require("./OrderReplacementItem"), exports);
 __exportStar(require("./OrderReplacementResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.81-RC",
+  "version": "4.0.82-RC",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/OrderApi.ts

@@ -57,6 +57,9 @@ import {
     OrderQueryBatch,
     OrderQueryBatchFromJSON,
     OrderQueryBatchToJSON,
+    OrderRefundableResponse,
+    OrderRefundableResponseFromJSON,
+    OrderRefundableResponseToJSON,
     OrderReplacement,
     OrderReplacementFromJSON,
     OrderReplacementToJSON,
@@ -177,6 +180,10 @@ export interface InsertOrderRequest {
     expand?: string;
 }
 
+export interface IsRefundableOrderRequest {
+    orderId: string;
+}
+
 export interface ProcessPaymentRequest {
     orderId: string;
     processPaymentRequest: OrderProcessPaymentRequest;
@@ -522,6 +529,22 @@ export interface OrderApiInterface {
      */
     insertOrder(requestParameters: InsertOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
 
+    /**
+     * Determine if an order can be refunded based upon payment method and age 
+     * @summary Determine if an order can be refunded
+     * @param {string} orderId The order id to check for refundable order.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>>;
+
+    /**
+     * Determine if an order can be refunded based upon payment method and age 
+     * Determine if an order can be refunded
+     */
+    isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse>;
+
     /**
      * Process payment on order 
      * @summary Process payment
@@ -1491,6 +1514,47 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
         return await response.value();
     }
 
+    /**
+     * Determine if an order can be refunded based upon payment method and age 
+     * Determine if an order can be refunded
+     */
+    async isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>> {
+        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+            throw new runtime.RequiredError('orderId','Required parameter requestParameters.orderId was null or undefined when calling isRefundableOrder.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["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: `/order/orders/{order_id}/refundable`.replace(`{${"order_id"}}`, encodeURIComponent(String(requestParameters.orderId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderRefundableResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Determine if an order can be refunded based upon payment method and age 
+     * Determine if an order can be refunded
+     */
+    async isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse> {
+        const response = await this.isRefundableOrderRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Process payment on order 
      * Process payment

package/src/models/OrderRefundableResponse.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface OrderRefundableResponse
+ */
+export interface OrderRefundableResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof OrderRefundableResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof OrderRefundableResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Whether the order is refundable or not.
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    refundable?: boolean;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof OrderRefundableResponse
+     */
+    warning?: Warning;
+}
+
+export function OrderRefundableResponseFromJSON(json: any): OrderRefundableResponse {
+    return OrderRefundableResponseFromJSONTyped(json, false);
+}
+
+export function OrderRefundableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderRefundableResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'refundable': !exists(json, 'refundable') ? undefined : json['refundable'],
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function OrderRefundableResponseToJSON(value?: OrderRefundableResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'refundable': value.refundable,
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -542,6 +542,7 @@ export * from './OrderProperty';
 export * from './OrderQuery';
 export * from './OrderQueryBatch';
 export * from './OrderQuote';
+export * from './OrderRefundableResponse';
 export * from './OrderReplacement';
 export * from './OrderReplacementItem';
 export * from './OrderReplacementResponse';