ultracart_rest_api_v2_typescript 4.0.119-RC → 4.0.121-RC

package/.openapi-generator/FILES

@@ -622,6 +622,7 @@ src/models/OrderTaxes.ts
 src/models/OrderTokenResponse.ts
 src/models/OrderTrackingNumberDetail.ts
 src/models/OrderTrackingNumberDetails.ts
+src/models/OrderTransactionalMerchantNote.ts
 src/models/OrdersResponse.ts
 src/models/Permission.ts
 src/models/PointOfSaleLocation.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.119-RC
+## ultracart_rest_api_v2_typescript@4.0.121-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.119-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.121-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.121-RC | 01/23/2023 | conversation - method to fetch single engagement record |
+| 4.0.120-RC | 01/19/2023 | added skip_on_rebill field to coupon object |
 | 4.0.119-RC | 01/19/2023 | convo - getConversationPermissions added |
 | 4.0.118-RC | 01/18/2023 | conversation get dept member list method added |
 | 4.0.117-RC | 01/18/2023 | conversation dept members |

package/dist/apis/ConversationApi.d.ts

@@ -27,6 +27,9 @@ export interface GetConversationRequest {
 export interface GetConversationContextRequest {
     conversationUuid: string;
 }
+export interface GetConversationEngagementRequest {
+    conversationEngagementOid: number;
+}
 export interface GetConversationMessagesRequest {
     conversationUuid: string;
     since: number;
@@ -231,6 +234,20 @@ export interface ConversationApiInterface {
      * Retrieve a list of departments ordered by name
      */
     getConversationDepartments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversationEngagementOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationEngagementRaw(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+    /**
+     * Retrieve an engagement
+     * Retrieve an engagement
+     */
+    getConversationEngagement(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name
@@ -623,6 +640,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Retrieve a list of departments ordered by name
      */
     getConversationDepartments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve an engagement
+     * Retrieve an engagement
+     */
+    getConversationEngagementRaw(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+    /**
+     * Retrieve an engagement
+     * Retrieve an engagement
+     */
+    getConversationEngagement(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
     /**
      * Retrieve a list of engagements ordered by name
      * Retrieve a list of engagements ordered by name

package/dist/apis/ConversationApi.js

@@ -645,6 +645,65 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve an engagement
+     * Retrieve an engagement
+     */
+    ConversationApi.prototype.getConversationEngagementRaw = 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.conversationEngagementOid === null || requestParameters.conversationEngagementOid === undefined) {
+                            throw new runtime.RequiredError('conversationEngagementOid', 'Required parameter requestParameters.conversationEngagementOid was null or undefined when calling getConversationEngagement.');
+                        }
+                        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", ["conversation_read"])];
+                    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: "/conversation/engagements/{conversation_engagement_oid}".replace("{".concat("conversation_engagement_oid", "}"), encodeURIComponent(String(requestParameters.conversationEngagementOid))),
+                                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.ConversationEngagementResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve an engagement
+     * Retrieve an engagement
+     */
+    ConversationApi.prototype.getConversationEngagement = 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.getConversationEngagementRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a list of engagements ordered by name
      * Retrieve a list of engagements ordered by name

package/dist/models/Coupon.d.ts

@@ -399,6 +399,12 @@ export interface Coupon {
      * @memberof Coupon
      */
     restrict_by_storefronts?: Array<CouponRestriction>;
+    /**
+     * Skip this coupon when it is on a rebill of an auto order.
+     * @type {boolean}
+     * @memberof Coupon
+     */
+    skip_on_rebill?: boolean;
     /**
      * Date/time when coupon is valid
      * @type {string}

package/dist/models/Coupon.js

@@ -128,6 +128,7 @@ function CouponFromJSONTyped(json, ignoreDiscriminator) {
         'restrict_by_postal_codes': !(0, runtime_1.exists)(json, 'restrict_by_postal_codes') ? undefined : json['restrict_by_postal_codes'],
         'restrict_by_screen_branding_theme_codes': !(0, runtime_1.exists)(json, 'restrict_by_screen_branding_theme_codes') ? undefined : (json['restrict_by_screen_branding_theme_codes'].map(CouponRestriction_1.CouponRestrictionFromJSON)),
         'restrict_by_storefronts': !(0, runtime_1.exists)(json, 'restrict_by_storefronts') ? undefined : (json['restrict_by_storefronts'].map(CouponRestriction_1.CouponRestrictionFromJSON)),
+        'skip_on_rebill': !(0, runtime_1.exists)(json, 'skip_on_rebill') ? undefined : json['skip_on_rebill'],
         'start_dts': !(0, runtime_1.exists)(json, 'start_dts') ? undefined : json['start_dts'],
         'super_coupon': !(0, runtime_1.exists)(json, 'super_coupon') ? undefined : json['super_coupon'],
         'tiered_amount_off_items': !(0, runtime_1.exists)(json, 'tiered_amount_off_items') ? undefined : (0, CouponTieredAmountOffItems_1.CouponTieredAmountOffItemsFromJSON)(json['tiered_amount_off_items']),
@@ -204,6 +205,7 @@ function CouponToJSON(value) {
         'restrict_by_postal_codes': value.restrict_by_postal_codes,
         'restrict_by_screen_branding_theme_codes': value.restrict_by_screen_branding_theme_codes === undefined ? undefined : (value.restrict_by_screen_branding_theme_codes.map(CouponRestriction_1.CouponRestrictionToJSON)),
         'restrict_by_storefronts': value.restrict_by_storefronts === undefined ? undefined : (value.restrict_by_storefronts.map(CouponRestriction_1.CouponRestrictionToJSON)),
+        'skip_on_rebill': value.skip_on_rebill,
         'start_dts': value.start_dts,
         'super_coupon': value.super_coupon,
         'tiered_amount_off_items': (0, CouponTieredAmountOffItems_1.CouponTieredAmountOffItemsToJSON)(value.tiered_amount_off_items),

package/dist/models/OrderInternal.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { OrderTransactionalMerchantNote } from './OrderTransactionalMerchantNote';
 /**
  *
  * @export
@@ -22,7 +23,7 @@ export interface OrderInternal {
      */
     exported_to_accounting?: boolean;
     /**
-     * Merchant notes
+     * Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled.
      * @type {string}
      * @memberof OrderInternal
      */
@@ -45,6 +46,12 @@ export interface OrderInternal {
      * @memberof OrderInternal
      */
     sales_rep_code?: string;
+    /**
+     * Transactional merchant notes
+     * @type {Array<OrderTransactionalMerchantNote>}
+     * @memberof OrderInternal
+     */
+    transactional_merchant_notes?: Array<OrderTransactionalMerchantNote>;
 }
 export declare function OrderInternalFromJSON(json: any): OrderInternal;
 export declare function OrderInternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderInternal;

package/dist/models/OrderInternal.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrderInternalToJSON = exports.OrderInternalFromJSONTyped = exports.OrderInternalFromJSON = void 0;
 var runtime_1 = require("../runtime");
+var OrderTransactionalMerchantNote_1 = require("./OrderTransactionalMerchantNote");
 function OrderInternalFromJSON(json) {
     return OrderInternalFromJSONTyped(json, false);
 }
@@ -29,6 +30,7 @@ function OrderInternalFromJSONTyped(json, ignoreDiscriminator) {
         'placed_by_user': !(0, runtime_1.exists)(json, 'placed_by_user') ? undefined : json['placed_by_user'],
         'refund_by_user': !(0, runtime_1.exists)(json, 'refund_by_user') ? undefined : json['refund_by_user'],
         'sales_rep_code': !(0, runtime_1.exists)(json, 'sales_rep_code') ? undefined : json['sales_rep_code'],
+        'transactional_merchant_notes': !(0, runtime_1.exists)(json, 'transactional_merchant_notes') ? undefined : (json['transactional_merchant_notes'].map(OrderTransactionalMerchantNote_1.OrderTransactionalMerchantNoteFromJSON)),
     };
 }
 exports.OrderInternalFromJSONTyped = OrderInternalFromJSONTyped;
@@ -45,6 +47,7 @@ function OrderInternalToJSON(value) {
         'placed_by_user': value.placed_by_user,
         'refund_by_user': value.refund_by_user,
         'sales_rep_code': value.sales_rep_code,
+        'transactional_merchant_notes': value.transactional_merchant_notes === undefined ? undefined : (value.transactional_merchant_notes.map(OrderTransactionalMerchantNote_1.OrderTransactionalMerchantNoteToJSON)),
     };
 }
 exports.OrderInternalToJSON = OrderInternalToJSON;

package/dist/models/OrderTransactionalMerchantNote.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 OrderTransactionalMerchantNote
+ */
+export interface OrderTransactionalMerchantNote {
+    /**
+     * IP Address
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    ip_address?: string;
+    /**
+     * note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note?: string;
+    /**
+     * Timestamp when the note was added
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note_dts?: string;
+    /**
+     * User that wrote the merchant note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    user?: string;
+}
+export declare function OrderTransactionalMerchantNoteFromJSON(json: any): OrderTransactionalMerchantNote;
+export declare function OrderTransactionalMerchantNoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderTransactionalMerchantNote;
+export declare function OrderTransactionalMerchantNoteToJSON(value?: OrderTransactionalMerchantNote | null): any;

package/dist/models/OrderTransactionalMerchantNote.js

@@ -0,0 +1,48 @@
+"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.OrderTransactionalMerchantNoteToJSON = exports.OrderTransactionalMerchantNoteFromJSONTyped = exports.OrderTransactionalMerchantNoteFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function OrderTransactionalMerchantNoteFromJSON(json) {
+    return OrderTransactionalMerchantNoteFromJSONTyped(json, false);
+}
+exports.OrderTransactionalMerchantNoteFromJSON = OrderTransactionalMerchantNoteFromJSON;
+function OrderTransactionalMerchantNoteFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'ip_address': !(0, runtime_1.exists)(json, 'ip_address') ? undefined : json['ip_address'],
+        'note': !(0, runtime_1.exists)(json, 'note') ? undefined : json['note'],
+        'note_dts': !(0, runtime_1.exists)(json, 'note_dts') ? undefined : json['note_dts'],
+        'user': !(0, runtime_1.exists)(json, 'user') ? undefined : json['user'],
+    };
+}
+exports.OrderTransactionalMerchantNoteFromJSONTyped = OrderTransactionalMerchantNoteFromJSONTyped;
+function OrderTransactionalMerchantNoteToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'ip_address': value.ip_address,
+        'note': value.note,
+        'note_dts': value.note_dts,
+        'user': value.user,
+    };
+}
+exports.OrderTransactionalMerchantNoteToJSON = OrderTransactionalMerchantNoteToJSON;

package/dist/models/index.d.ts

@@ -597,6 +597,7 @@ export * from './OrderTaxes';
 export * from './OrderTokenResponse';
 export * from './OrderTrackingNumberDetail';
 export * from './OrderTrackingNumberDetails';
+export * from './OrderTransactionalMerchantNote';
 export * from './OrdersResponse';
 export * from './Permission';
 export * from './PointOfSaleLocation';

package/dist/models/index.js

@@ -615,6 +615,7 @@ __exportStar(require("./OrderTaxes"), exports);
 __exportStar(require("./OrderTokenResponse"), exports);
 __exportStar(require("./OrderTrackingNumberDetail"), exports);
 __exportStar(require("./OrderTrackingNumberDetails"), exports);
+__exportStar(require("./OrderTransactionalMerchantNote"), exports);
 __exportStar(require("./OrdersResponse"), exports);
 __exportStar(require("./Permission"), exports);
 __exportStar(require("./PointOfSaleLocation"), exports);

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -122,6 +122,10 @@ export interface GetConversationContextRequest {
     conversationUuid: string;
 }
 
+export interface GetConversationEngagementRequest {
+    conversationEngagementOid: number;
+}
+
 export interface GetConversationMessagesRequest {
     conversationUuid: string;
     since: number;
@@ -363,6 +367,22 @@ export interface ConversationApiInterface {
      */
     getConversationDepartments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentsResponse>;
 
+    /**
+     * Retrieve an engagement 
+     * @summary Retrieve an engagement
+     * @param {number} conversationEngagementOid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationEngagementRaw(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+
+    /**
+     * Retrieve an engagement 
+     * Retrieve an engagement
+     */
+    getConversationEngagement(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
+
     /**
      * Retrieve a list of engagements ordered by name 
      * @summary Retrieve a list of engagements ordered by name
@@ -1087,6 +1107,47 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Retrieve an engagement 
+     * Retrieve an engagement
+     */
+    async getConversationEngagementRaw(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>> {
+        if (requestParameters.conversationEngagementOid === null || requestParameters.conversationEngagementOid === undefined) {
+            throw new runtime.RequiredError('conversationEngagementOid','Required parameter requestParameters.conversationEngagementOid was null or undefined when calling getConversationEngagement.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_read"]);
+        }
+
+        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: `/conversation/engagements/{conversation_engagement_oid}`.replace(`{${"conversation_engagement_oid"}}`, encodeURIComponent(String(requestParameters.conversationEngagementOid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationEngagementResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve an engagement 
+     * Retrieve an engagement
+     */
+    async getConversationEngagement(requestParameters: GetConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse> {
+        const response = await this.getConversationEngagementRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a list of engagements ordered by name 
      * Retrieve a list of engagements ordered by name

package/src/models/Coupon.ts

@@ -644,6 +644,12 @@ export interface Coupon {
      * @memberof Coupon
      */
     restrict_by_storefronts?: Array<CouponRestriction>;
+    /**
+     * Skip this coupon when it is on a rebill of an auto order.
+     * @type {boolean}
+     * @memberof Coupon
+     */
+    skip_on_rebill?: boolean;
     /**
      * Date/time when coupon is valid
      * @type {string}
@@ -766,6 +772,7 @@ export function CouponFromJSONTyped(json: any, ignoreDiscriminator: boolean): Co
         'restrict_by_postal_codes': !exists(json, 'restrict_by_postal_codes') ? undefined : json['restrict_by_postal_codes'],
         'restrict_by_screen_branding_theme_codes': !exists(json, 'restrict_by_screen_branding_theme_codes') ? undefined : ((json['restrict_by_screen_branding_theme_codes'] as Array<any>).map(CouponRestrictionFromJSON)),
         'restrict_by_storefronts': !exists(json, 'restrict_by_storefronts') ? undefined : ((json['restrict_by_storefronts'] as Array<any>).map(CouponRestrictionFromJSON)),
+        'skip_on_rebill': !exists(json, 'skip_on_rebill') ? undefined : json['skip_on_rebill'],
         'start_dts': !exists(json, 'start_dts') ? undefined : json['start_dts'],
         'super_coupon': !exists(json, 'super_coupon') ? undefined : json['super_coupon'],
         'tiered_amount_off_items': !exists(json, 'tiered_amount_off_items') ? undefined : CouponTieredAmountOffItemsFromJSON(json['tiered_amount_off_items']),
@@ -843,6 +850,7 @@ export function CouponToJSON(value?: Coupon | null): any {
         'restrict_by_postal_codes': value.restrict_by_postal_codes,
         'restrict_by_screen_branding_theme_codes': value.restrict_by_screen_branding_theme_codes === undefined ? undefined : ((value.restrict_by_screen_branding_theme_codes as Array<any>).map(CouponRestrictionToJSON)),
         'restrict_by_storefronts': value.restrict_by_storefronts === undefined ? undefined : ((value.restrict_by_storefronts as Array<any>).map(CouponRestrictionToJSON)),
+        'skip_on_rebill': value.skip_on_rebill,
         'start_dts': value.start_dts,
         'super_coupon': value.super_coupon,
         'tiered_amount_off_items': CouponTieredAmountOffItemsToJSON(value.tiered_amount_off_items),

package/src/models/OrderInternal.ts

@@ -13,6 +13,13 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import {
+    OrderTransactionalMerchantNote,
+    OrderTransactionalMerchantNoteFromJSON,
+    OrderTransactionalMerchantNoteFromJSONTyped,
+    OrderTransactionalMerchantNoteToJSON,
+} from './OrderTransactionalMerchantNote';
+
 /**
  * 
  * @export
@@ -26,7 +33,7 @@ export interface OrderInternal {
      */
     exported_to_accounting?: boolean;
     /**
-     * Merchant notes
+     * Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled.
      * @type {string}
      * @memberof OrderInternal
      */
@@ -49,6 +56,12 @@ export interface OrderInternal {
      * @memberof OrderInternal
      */
     sales_rep_code?: string;
+    /**
+     * Transactional merchant notes
+     * @type {Array<OrderTransactionalMerchantNote>}
+     * @memberof OrderInternal
+     */
+    transactional_merchant_notes?: Array<OrderTransactionalMerchantNote>;
 }
 
 export function OrderInternalFromJSON(json: any): OrderInternal {
@@ -66,6 +79,7 @@ export function OrderInternalFromJSONTyped(json: any, ignoreDiscriminator: boole
         'placed_by_user': !exists(json, 'placed_by_user') ? undefined : json['placed_by_user'],
         'refund_by_user': !exists(json, 'refund_by_user') ? undefined : json['refund_by_user'],
         'sales_rep_code': !exists(json, 'sales_rep_code') ? undefined : json['sales_rep_code'],
+        'transactional_merchant_notes': !exists(json, 'transactional_merchant_notes') ? undefined : ((json['transactional_merchant_notes'] as Array<any>).map(OrderTransactionalMerchantNoteFromJSON)),
     };
 }
 
@@ -83,6 +97,7 @@ export function OrderInternalToJSON(value?: OrderInternal | null): any {
         'placed_by_user': value.placed_by_user,
         'refund_by_user': value.refund_by_user,
         'sales_rep_code': value.sales_rep_code,
+        'transactional_merchant_notes': value.transactional_merchant_notes === undefined ? undefined : ((value.transactional_merchant_notes as Array<any>).map(OrderTransactionalMerchantNoteToJSON)),
     };
 }
 

package/src/models/OrderTransactionalMerchantNote.ts

@@ -0,0 +1,80 @@
+/* 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 OrderTransactionalMerchantNote
+ */
+export interface OrderTransactionalMerchantNote {
+    /**
+     * IP Address
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    ip_address?: string;
+    /**
+     * note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note?: string;
+    /**
+     * Timestamp when the note was added
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note_dts?: string;
+    /**
+     * User that wrote the merchant note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    user?: string;
+}
+
+export function OrderTransactionalMerchantNoteFromJSON(json: any): OrderTransactionalMerchantNote {
+    return OrderTransactionalMerchantNoteFromJSONTyped(json, false);
+}
+
+export function OrderTransactionalMerchantNoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderTransactionalMerchantNote {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'ip_address': !exists(json, 'ip_address') ? undefined : json['ip_address'],
+        'note': !exists(json, 'note') ? undefined : json['note'],
+        'note_dts': !exists(json, 'note_dts') ? undefined : json['note_dts'],
+        'user': !exists(json, 'user') ? undefined : json['user'],
+    };
+}
+
+export function OrderTransactionalMerchantNoteToJSON(value?: OrderTransactionalMerchantNote | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'ip_address': value.ip_address,
+        'note': value.note,
+        'note_dts': value.note_dts,
+        'user': value.user,
+    };
+}
+

package/src/models/index.ts

@@ -599,6 +599,7 @@ export * from './OrderTaxes';
 export * from './OrderTokenResponse';
 export * from './OrderTrackingNumberDetail';
 export * from './OrderTrackingNumberDetails';
+export * from './OrderTransactionalMerchantNote';
 export * from './OrdersResponse';
 export * from './Permission';
 export * from './PointOfSaleLocation';