ultracart_rest_api_v2_typescript 4.0.138 → 4.0.140

package/.openapi-generator/FILES

@@ -583,6 +583,8 @@ src/models/OrderCoupon.ts
 src/models/OrderDigitalItem.ts
 src/models/OrderDigitalOrder.ts
 src/models/OrderEdi.ts
+src/models/OrderEdiDocument.ts
+src/models/OrderEdiDocumentsResponse.ts
 src/models/OrderFormat.ts
 src/models/OrderFormatResponse.ts
 src/models/OrderFraudScore.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.138
+## ultracart_rest_api_v2_typescript@4.0.140
 
 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.138 --save
+npm install ultracart_rest_api_v2_typescript@4.0.140 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.140 | 03/21/2023 | order api - new stage named Hold |
+| 4.0.139 | 03/14/2023 | order.getOrderEdiDocuments |
 | 4.0.138 | 03/01/2023 | convo - add sentiment record to conversation obj |
 | 4.0.137 | 02/22/2023 | convo - customer initiated flag on engagement |
 | 4.0.136 | 02/20/2023 | refund reasons |

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, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
+import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
 export interface AdjustOrderTotalRequest {
     orderId: string;
     desiredTotal: string;
@@ -54,6 +54,9 @@ export interface GetOrderByTokenRequest {
     orderByTokenQuery: OrderByTokenQuery;
     expand?: string;
 }
+export interface GetOrderEdiDocumentsRequest {
+    orderId: string;
+}
 export interface GetOrdersRequest {
     orderId?: string;
     paymentMethod?: string;
@@ -333,6 +336,20 @@ export interface OrderApiInterface {
      * Retrieve an order using a token
      */
     getOrderByToken(requestParameters: GetOrderByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * Retrieve EDI documents associated with this order.
+     * @summary Retrieve EDI documents associated with this order.
+     * @param {string} orderId The order id to retrieve EDI documents for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrderEdiDocumentsRaw(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderEdiDocumentsResponse>>;
+    /**
+     * Retrieve EDI documents associated with this order.
+     * Retrieve EDI documents associated with this order.
+     */
+    getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
     /**
      * Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve orders
@@ -684,6 +701,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Retrieve an order using a token
      */
     getOrderByToken(requestParameters: GetOrderByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * Retrieve EDI documents associated with this order.
+     * Retrieve EDI documents associated with this order.
+     */
+    getOrderEdiDocumentsRaw(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderEdiDocumentsResponse>>;
+    /**
+     * Retrieve EDI documents associated with this order.
+     * Retrieve EDI documents associated with this order.
+     */
+    getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
     /**
      * Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * Retrieve orders

package/dist/apis/OrderApi.js

@@ -863,6 +863,65 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve EDI documents associated with this order.
+     * Retrieve EDI documents associated with this order.
+     */
+    OrderApi.prototype.getOrderEdiDocumentsRaw = 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 getOrderEdiDocuments.');
+                        }
+                        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}/edi".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.OrderEdiDocumentsResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve EDI documents associated with this order.
+     * Retrieve EDI documents associated with this order.
+     */
+    OrderApi.prototype.getOrderEdiDocuments = 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.getOrderEdiDocumentsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * Retrieve orders

package/dist/models/Order.d.ts

@@ -287,6 +287,7 @@ export declare const OrderCurrentStageEnum: {
     readonly Unknown: "Unknown";
     readonly PreOrdered: "Pre-ordered";
     readonly AdvancedOrderRouting: "Advanced Order Routing";
+    readonly Hold: "Hold";
 };
 export type OrderCurrentStageEnum = typeof OrderCurrentStageEnum[keyof typeof OrderCurrentStageEnum];
 export declare function OrderFromJSON(json: any): Order;

package/dist/models/Order.js

@@ -57,7 +57,8 @@ exports.OrderCurrentStageEnum = {
     LeastCostRouting: 'Least Cost Routing',
     Unknown: 'Unknown',
     PreOrdered: 'Pre-ordered',
-    AdvancedOrderRouting: 'Advanced Order Routing'
+    AdvancedOrderRouting: 'Advanced Order Routing',
+    Hold: 'Hold'
 };
 function OrderFromJSON(json) {
     return OrderFromJSONTyped(json, false);

package/dist/models/OrderEdiDocument.d.ts

@@ -0,0 +1,113 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface OrderEdiDocument
+ */
+export interface OrderEdiDocument {
+    /**
+     * Direction the document flowed
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    direction?: OrderEdiDocumentDirectionEnum;
+    /**
+     * Date/time the document was created/received
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    doc_dts?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    document?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    document_type_description?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderEdiDocument
+     */
+    document_type_number?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    external_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    functional_acknowledgement?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    functional_acknowledgement_dts?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof OrderEdiDocument
+     */
+    functional_acknowledgement_pending?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderEdiDocument
+     */
+    group_control_number?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    internal_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    merchant_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    order_id?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof OrderEdiDocument
+     */
+    test_mode?: boolean;
+}
+/**
+ * @export
+ */
+export declare const OrderEdiDocumentDirectionEnum: {
+    readonly Inbound: "inbound";
+    readonly Outbound: "outbound";
+};
+export type OrderEdiDocumentDirectionEnum = typeof OrderEdiDocumentDirectionEnum[keyof typeof OrderEdiDocumentDirectionEnum];
+export declare function OrderEdiDocumentFromJSON(json: any): OrderEdiDocument;
+export declare function OrderEdiDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderEdiDocument;
+export declare function OrderEdiDocumentToJSON(value?: OrderEdiDocument | null): any;

package/dist/models/OrderEdiDocument.js

@@ -0,0 +1,75 @@
+"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.OrderEdiDocumentToJSON = exports.OrderEdiDocumentFromJSONTyped = exports.OrderEdiDocumentFromJSON = exports.OrderEdiDocumentDirectionEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.OrderEdiDocumentDirectionEnum = {
+    Inbound: 'inbound',
+    Outbound: 'outbound'
+};
+function OrderEdiDocumentFromJSON(json) {
+    return OrderEdiDocumentFromJSONTyped(json, false);
+}
+exports.OrderEdiDocumentFromJSON = OrderEdiDocumentFromJSON;
+function OrderEdiDocumentFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'direction': !(0, runtime_1.exists)(json, 'direction') ? undefined : json['direction'],
+        'doc_dts': !(0, runtime_1.exists)(json, 'doc_dts') ? undefined : json['doc_dts'],
+        'document': !(0, runtime_1.exists)(json, 'document') ? undefined : json['document'],
+        'document_type_description': !(0, runtime_1.exists)(json, 'document_type_description') ? undefined : json['document_type_description'],
+        'document_type_number': !(0, runtime_1.exists)(json, 'document_type_number') ? undefined : json['document_type_number'],
+        'external_id': !(0, runtime_1.exists)(json, 'external_id') ? undefined : json['external_id'],
+        'functional_acknowledgement': !(0, runtime_1.exists)(json, 'functional_acknowledgement') ? undefined : json['functional_acknowledgement'],
+        'functional_acknowledgement_dts': !(0, runtime_1.exists)(json, 'functional_acknowledgement_dts') ? undefined : json['functional_acknowledgement_dts'],
+        'functional_acknowledgement_pending': !(0, runtime_1.exists)(json, 'functional_acknowledgement_pending') ? undefined : json['functional_acknowledgement_pending'],
+        'group_control_number': !(0, runtime_1.exists)(json, 'group_control_number') ? undefined : json['group_control_number'],
+        'internal_id': !(0, runtime_1.exists)(json, 'internal_id') ? undefined : json['internal_id'],
+        'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
+        'test_mode': !(0, runtime_1.exists)(json, 'test_mode') ? undefined : json['test_mode'],
+    };
+}
+exports.OrderEdiDocumentFromJSONTyped = OrderEdiDocumentFromJSONTyped;
+function OrderEdiDocumentToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'direction': value.direction,
+        'doc_dts': value.doc_dts,
+        'document': value.document,
+        'document_type_description': value.document_type_description,
+        'document_type_number': value.document_type_number,
+        'external_id': value.external_id,
+        'functional_acknowledgement': value.functional_acknowledgement,
+        'functional_acknowledgement_dts': value.functional_acknowledgement_dts,
+        'functional_acknowledgement_pending': value.functional_acknowledgement_pending,
+        'group_control_number': value.group_control_number,
+        'internal_id': value.internal_id,
+        'merchant_id': value.merchant_id,
+        'order_id': value.order_id,
+        'test_mode': value.test_mode,
+    };
+}
+exports.OrderEdiDocumentToJSON = OrderEdiDocumentToJSON;

package/dist/models/OrderEdiDocumentsResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { OrderEdiDocument } from './OrderEdiDocument';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface OrderEdiDocumentsResponse
+ */
+export interface OrderEdiDocumentsResponse {
+    /**
+     * edi_documents
+     * @type {Array<OrderEdiDocument>}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    ediDocuments?: Array<OrderEdiDocument>;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    warning?: Warning;
+}
+export declare function OrderEdiDocumentsResponseFromJSON(json: any): OrderEdiDocumentsResponse;
+export declare function OrderEdiDocumentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderEdiDocumentsResponse;
+export declare function OrderEdiDocumentsResponseToJSON(value?: OrderEdiDocumentsResponse | null): any;

package/dist/models/OrderEdiDocumentsResponse.js

@@ -0,0 +1,54 @@
+"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.OrderEdiDocumentsResponseToJSON = exports.OrderEdiDocumentsResponseFromJSONTyped = exports.OrderEdiDocumentsResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var OrderEdiDocument_1 = require("./OrderEdiDocument");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function OrderEdiDocumentsResponseFromJSON(json) {
+    return OrderEdiDocumentsResponseFromJSONTyped(json, false);
+}
+exports.OrderEdiDocumentsResponseFromJSON = OrderEdiDocumentsResponseFromJSON;
+function OrderEdiDocumentsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'ediDocuments': !(0, runtime_1.exists)(json, 'ediDocuments') ? undefined : (json['ediDocuments'].map(OrderEdiDocument_1.OrderEdiDocumentFromJSON)),
+        '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']),
+        '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.OrderEdiDocumentsResponseFromJSONTyped = OrderEdiDocumentsResponseFromJSONTyped;
+function OrderEdiDocumentsResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'ediDocuments': value.ediDocuments === undefined ? undefined : (value.ediDocuments.map(OrderEdiDocument_1.OrderEdiDocumentToJSON)),
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.OrderEdiDocumentsResponseToJSON = OrderEdiDocumentsResponseToJSON;

package/dist/models/index.d.ts

@@ -558,6 +558,8 @@ export * from './OrderCoupon';
 export * from './OrderDigitalItem';
 export * from './OrderDigitalOrder';
 export * from './OrderEdi';
+export * from './OrderEdiDocument';
+export * from './OrderEdiDocumentsResponse';
 export * from './OrderFormat';
 export * from './OrderFormatResponse';
 export * from './OrderFraudScore';

package/dist/models/index.js

@@ -576,6 +576,8 @@ __exportStar(require("./OrderCoupon"), exports);
 __exportStar(require("./OrderDigitalItem"), exports);
 __exportStar(require("./OrderDigitalOrder"), exports);
 __exportStar(require("./OrderEdi"), exports);
+__exportStar(require("./OrderEdiDocument"), exports);
+__exportStar(require("./OrderEdiDocumentsResponse"), exports);
 __exportStar(require("./OrderFormat"), exports);
 __exportStar(require("./OrderFormatResponse"), exports);
 __exportStar(require("./OrderFraudScore"), exports);

package/package.json

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

package/src/apis/OrderApi.ts

@@ -36,6 +36,9 @@ import {
     OrderByTokenQuery,
     OrderByTokenQueryFromJSON,
     OrderByTokenQueryToJSON,
+    OrderEdiDocumentsResponse,
+    OrderEdiDocumentsResponseFromJSON,
+    OrderEdiDocumentsResponseToJSON,
     OrderFormat,
     OrderFormatFromJSON,
     OrderFormatToJSON,
@@ -135,6 +138,10 @@ export interface GetOrderByTokenRequest {
     expand?: string;
 }
 
+export interface GetOrderEdiDocumentsRequest {
+    orderId: string;
+}
+
 export interface GetOrdersRequest {
     orderId?: string;
     paymentMethod?: string;
@@ -452,6 +459,22 @@ export interface OrderApiInterface {
      */
     getOrderByToken(requestParameters: GetOrderByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
 
+    /**
+     * Retrieve EDI documents associated with this order. 
+     * @summary Retrieve EDI documents associated with this order.
+     * @param {string} orderId The order id to retrieve EDI documents for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrderEdiDocumentsRaw(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderEdiDocumentsResponse>>;
+
+    /**
+     * Retrieve EDI documents associated with this order. 
+     * Retrieve EDI documents associated with this order.
+     */
+    getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
+
     /**
      * Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
      * @summary Retrieve orders
@@ -1261,6 +1284,47 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieve EDI documents associated with this order. 
+     * Retrieve EDI documents associated with this order.
+     */
+    async getOrderEdiDocumentsRaw(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderEdiDocumentsResponse>> {
+        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+            throw new runtime.RequiredError('orderId','Required parameter requestParameters.orderId was null or undefined when calling getOrderEdiDocuments.');
+        }
+
+        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}/edi`.replace(`{${"order_id"}}`, encodeURIComponent(String(requestParameters.orderId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderEdiDocumentsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve EDI documents associated with this order. 
+     * Retrieve EDI documents associated with this order.
+     */
+    async getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse> {
+        const response = await this.getOrderEdiDocumentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
      * Retrieve orders

package/src/models/Order.ts

@@ -428,7 +428,8 @@ export const OrderCurrentStageEnum = {
     LeastCostRouting: 'Least Cost Routing',
     Unknown: 'Unknown',
     PreOrdered: 'Pre-ordered',
-    AdvancedOrderRouting: 'Advanced Order Routing'
+    AdvancedOrderRouting: 'Advanced Order Routing',
+    Hold: 'Hold'
 } as const;
 export type OrderCurrentStageEnum = typeof OrderCurrentStageEnum[keyof typeof OrderCurrentStageEnum];
 

package/src/models/OrderEdiDocument.ts

@@ -0,0 +1,171 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface OrderEdiDocument
+ */
+export interface OrderEdiDocument {
+    /**
+     * Direction the document flowed
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    direction?: OrderEdiDocumentDirectionEnum;
+    /**
+     * Date/time the document was created/received
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    doc_dts?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    document?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    document_type_description?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrderEdiDocument
+     */
+    document_type_number?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    external_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    functional_acknowledgement?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    functional_acknowledgement_dts?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrderEdiDocument
+     */
+    functional_acknowledgement_pending?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrderEdiDocument
+     */
+    group_control_number?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    internal_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    merchant_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderEdiDocument
+     */
+    order_id?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrderEdiDocument
+     */
+    test_mode?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const OrderEdiDocumentDirectionEnum = {
+    Inbound: 'inbound',
+    Outbound: 'outbound'
+} as const;
+export type OrderEdiDocumentDirectionEnum = typeof OrderEdiDocumentDirectionEnum[keyof typeof OrderEdiDocumentDirectionEnum];
+
+
+export function OrderEdiDocumentFromJSON(json: any): OrderEdiDocument {
+    return OrderEdiDocumentFromJSONTyped(json, false);
+}
+
+export function OrderEdiDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderEdiDocument {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'direction': !exists(json, 'direction') ? undefined : json['direction'],
+        'doc_dts': !exists(json, 'doc_dts') ? undefined : json['doc_dts'],
+        'document': !exists(json, 'document') ? undefined : json['document'],
+        'document_type_description': !exists(json, 'document_type_description') ? undefined : json['document_type_description'],
+        'document_type_number': !exists(json, 'document_type_number') ? undefined : json['document_type_number'],
+        'external_id': !exists(json, 'external_id') ? undefined : json['external_id'],
+        'functional_acknowledgement': !exists(json, 'functional_acknowledgement') ? undefined : json['functional_acknowledgement'],
+        'functional_acknowledgement_dts': !exists(json, 'functional_acknowledgement_dts') ? undefined : json['functional_acknowledgement_dts'],
+        'functional_acknowledgement_pending': !exists(json, 'functional_acknowledgement_pending') ? undefined : json['functional_acknowledgement_pending'],
+        'group_control_number': !exists(json, 'group_control_number') ? undefined : json['group_control_number'],
+        'internal_id': !exists(json, 'internal_id') ? undefined : json['internal_id'],
+        'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'order_id': !exists(json, 'order_id') ? undefined : json['order_id'],
+        'test_mode': !exists(json, 'test_mode') ? undefined : json['test_mode'],
+    };
+}
+
+export function OrderEdiDocumentToJSON(value?: OrderEdiDocument | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'direction': value.direction,
+        'doc_dts': value.doc_dts,
+        'document': value.document,
+        'document_type_description': value.document_type_description,
+        'document_type_number': value.document_type_number,
+        'external_id': value.external_id,
+        'functional_acknowledgement': value.functional_acknowledgement,
+        'functional_acknowledgement_dts': value.functional_acknowledgement_dts,
+        'functional_acknowledgement_pending': value.functional_acknowledgement_pending,
+        'group_control_number': value.group_control_number,
+        'internal_id': value.internal_id,
+        'merchant_id': value.merchant_id,
+        'order_id': value.order_id,
+        'test_mode': value.test_mode,
+    };
+}
+

package/src/models/OrderEdiDocumentsResponse.ts

@@ -0,0 +1,113 @@
+/* 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 {
+    OrderEdiDocument,
+    OrderEdiDocumentFromJSON,
+    OrderEdiDocumentFromJSONTyped,
+    OrderEdiDocumentToJSON,
+} from './OrderEdiDocument';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface OrderEdiDocumentsResponse
+ */
+export interface OrderEdiDocumentsResponse {
+    /**
+     * edi_documents
+     * @type {Array<OrderEdiDocument>}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    ediDocuments?: Array<OrderEdiDocument>;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof OrderEdiDocumentsResponse
+     */
+    warning?: Warning;
+}
+
+export function OrderEdiDocumentsResponseFromJSON(json: any): OrderEdiDocumentsResponse {
+    return OrderEdiDocumentsResponseFromJSONTyped(json, false);
+}
+
+export function OrderEdiDocumentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderEdiDocumentsResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'ediDocuments': !exists(json, 'ediDocuments') ? undefined : ((json['ediDocuments'] as Array<any>).map(OrderEdiDocumentFromJSON)),
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function OrderEdiDocumentsResponseToJSON(value?: OrderEdiDocumentsResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'ediDocuments': value.ediDocuments === undefined ? undefined : ((value.ediDocuments as Array<any>).map(OrderEdiDocumentToJSON)),
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -560,6 +560,8 @@ export * from './OrderCoupon';
 export * from './OrderDigitalItem';
 export * from './OrderDigitalOrder';
 export * from './OrderEdi';
+export * from './OrderEdiDocument';
+export * from './OrderEdiDocumentsResponse';
 export * from './OrderFormat';
 export * from './OrderFormatResponse';
 export * from './OrderFraudScore';