ultracart_rest_api_v2_typescript 4.0.87-RC → 4.0.89-RC

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.87-RC
+## ultracart_rest_api_v2_typescript@4.0.89-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.87-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.89-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.89-RC | 11/30/2022 | order item - addl fields for linking kits to kit components |
+| 4.0.88-RC | 11/29/2022 | converstation marked convo read method |
 | 4.0.87-RC | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
 | 4.0.86-RC | 11/21/2022 | conversation context method |
 | 4.0.85-RC | 11/21/2022 | adjusted conversation event model |

package/dist/apis/ConversationApi.d.ts

@@ -38,6 +38,9 @@ export interface JoinConversationRequest {
 export interface LeaveConversationRequest {
     conversationUuid: string;
 }
+export interface MarkReadConversationRequest {
+    conversationUuid: string;
+}
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
@@ -195,6 +198,20 @@ export interface ConversationApiInterface {
      * Leave a conversation
      */
     leaveConversation(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversationUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    markReadConversationRaw(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Mark a conversation as read
+     * Mark a conversation as read
+     */
+    markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -329,6 +346,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Leave a conversation
      */
     leaveConversation(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Mark a conversation as read
+     * Mark a conversation as read
+     */
+    markReadConversationRaw(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Mark a conversation as read
+     * Mark a conversation as read
+     */
+    markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Start a new conversation
      * Start a conversation

package/dist/apis/ConversationApi.js

@@ -669,6 +669,63 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Mark a conversation as read
+     * Mark a conversation as read
+     */
+    ConversationApi.prototype.markReadConversationRaw = 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.conversationUuid === null || requestParameters.conversationUuid === undefined) {
+                            throw new runtime.RequiredError('conversationUuid', 'Required parameter requestParameters.conversationUuid was null or undefined when calling markReadConversation.');
+                        }
+                        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_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: "/conversation/conversations/{conversation_uuid}/markread".replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(requestParameters.conversationUuid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Mark a conversation as read
+     * Mark a conversation as read
+     */
+    ConversationApi.prototype.markReadConversation = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.markReadConversationRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Start a new conversation
      * Start a conversation

package/dist/models/ConversationMessage.d.ts

@@ -46,6 +46,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     conversation_message_uuid?: string;
+    /**
+     * Delay message transmission until date/time
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    delay_until_dts?: string;
     /**
      *
      * @type {Array<string>}

package/dist/models/ConversationMessage.js

@@ -37,6 +37,7 @@ function ConversationMessageFromJSONTyped(json, ignoreDiscriminator) {
         'body': !(0, runtime_1.exists)(json, 'body') ? undefined : json['body'],
         'client_message_id': !(0, runtime_1.exists)(json, 'client_message_id') ? undefined : json['client_message_id'],
         'conversation_message_uuid': !(0, runtime_1.exists)(json, 'conversation_message_uuid') ? undefined : json['conversation_message_uuid'],
+        'delay_until_dts': !(0, runtime_1.exists)(json, 'delay_until_dts') ? undefined : json['delay_until_dts'],
         'media_urls': !(0, runtime_1.exists)(json, 'media_urls') ? undefined : json['media_urls'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
         'message_dts': !(0, runtime_1.exists)(json, 'message_dts') ? undefined : json['message_dts'],
@@ -60,6 +61,7 @@ function ConversationMessageToJSON(value) {
         'body': value.body,
         'client_message_id': value.client_message_id,
         'conversation_message_uuid': value.conversation_message_uuid,
+        'delay_until_dts': value.delay_until_dts,
         'media_urls': value.media_urls,
         'merchant_id': value.merchant_id,
         'message_dts': value.message_dts,

package/dist/models/OrderItem.d.ts

@@ -154,6 +154,12 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     height?: Distance;
+    /**
+     * Index of the item on the order (one based index)
+     * @type {number}
+     * @memberof OrderItem
+     */
+    item_index?: number;
     /**
      * Item reference object identifier used to linked to auto order item record
      * @type {number}
@@ -226,6 +232,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     packed_by_user?: string;
+    /**
+     * If this item is a kit component, this is the item index of the parent item (kit)
+     * @type {number}
+     * @memberof OrderItem
+     */
+    parent_item_index?: number;
+    /**
+     * If this item is a kit component, this is the item id of the parent item (kit)
+     * @type {string}
+     * @memberof OrderItem
+     */
+    parent_merchant_item_id?: string;
     /**
      * Perishable class of the item
      * @type {string}

package/dist/models/OrderItem.js

@@ -62,6 +62,7 @@ function OrderItemFromJSONTyped(json, ignoreDiscriminator) {
         'free_shipping': !(0, runtime_1.exists)(json, 'free_shipping') ? undefined : json['free_shipping'],
         'hazmat': !(0, runtime_1.exists)(json, 'hazmat') ? undefined : json['hazmat'],
         'height': !(0, runtime_1.exists)(json, 'height') ? undefined : (0, Distance_1.DistanceFromJSON)(json['height']),
+        'item_index': !(0, runtime_1.exists)(json, 'item_index') ? undefined : json['item_index'],
         'item_reference_oid': !(0, runtime_1.exists)(json, 'item_reference_oid') ? undefined : json['item_reference_oid'],
         'kit': !(0, runtime_1.exists)(json, 'kit') ? undefined : json['kit'],
         'kit_component': !(0, runtime_1.exists)(json, 'kit_component') ? undefined : json['kit_component'],
@@ -74,6 +75,8 @@ function OrderItemFromJSONTyped(json, ignoreDiscriminator) {
         'no_shipping_discount': !(0, runtime_1.exists)(json, 'no_shipping_discount') ? undefined : json['no_shipping_discount'],
         'options': !(0, runtime_1.exists)(json, 'options') ? undefined : (json['options'].map(OrderItemOption_1.OrderItemOptionFromJSON)),
         'packed_by_user': !(0, runtime_1.exists)(json, 'packed_by_user') ? undefined : json['packed_by_user'],
+        'parent_item_index': !(0, runtime_1.exists)(json, 'parent_item_index') ? undefined : json['parent_item_index'],
+        'parent_merchant_item_id': !(0, runtime_1.exists)(json, 'parent_merchant_item_id') ? undefined : json['parent_merchant_item_id'],
         'perishable_class': !(0, runtime_1.exists)(json, 'perishable_class') ? undefined : json['perishable_class'],
         'pricing_tier_name': !(0, runtime_1.exists)(json, 'pricing_tier_name') ? undefined : json['pricing_tier_name'],
         'properties': !(0, runtime_1.exists)(json, 'properties') ? undefined : (json['properties'].map(OrderItemProperty_1.OrderItemPropertyFromJSON)),
@@ -129,6 +132,7 @@ function OrderItemToJSON(value) {
         'free_shipping': value.free_shipping,
         'hazmat': value.hazmat,
         'height': (0, Distance_1.DistanceToJSON)(value.height),
+        'item_index': value.item_index,
         'item_reference_oid': value.item_reference_oid,
         'kit': value.kit,
         'kit_component': value.kit_component,
@@ -141,6 +145,8 @@ function OrderItemToJSON(value) {
         'no_shipping_discount': value.no_shipping_discount,
         'options': value.options === undefined ? undefined : (value.options.map(OrderItemOption_1.OrderItemOptionToJSON)),
         'packed_by_user': value.packed_by_user,
+        'parent_item_index': value.parent_item_index,
+        'parent_merchant_item_id': value.parent_merchant_item_id,
         'perishable_class': value.perishable_class,
         'pricing_tier_name': value.pricing_tier_name,
         'properties': value.properties === undefined ? undefined : (value.properties.map(OrderItemProperty_1.OrderItemPropertyToJSON)),

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -84,6 +84,10 @@ export interface LeaveConversationRequest {
     conversationUuid: string;
 }
 
+export interface MarkReadConversationRequest {
+    conversationUuid: string;
+}
+
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
@@ -263,6 +267,22 @@ export interface ConversationApiInterface {
      */
     leaveConversation(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Mark a conversation as read 
+     * @summary Mark a conversation as read
+     * @param {string} conversationUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    markReadConversationRaw(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Mark a conversation as read 
+     * Mark a conversation as read
+     */
+    markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * Start a new conversation 
      * @summary Start a conversation
@@ -722,6 +742,46 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         await this.leaveConversationRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Mark a conversation as read 
+     * Mark a conversation as read
+     */
+    async markReadConversationRaw(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.conversationUuid === null || requestParameters.conversationUuid === undefined) {
+            throw new runtime.RequiredError('conversationUuid','Required parameter requestParameters.conversationUuid was null or undefined when calling markReadConversation.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_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: `/conversation/conversations/{conversation_uuid}/markread`.replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(requestParameters.conversationUuid))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Mark a conversation as read 
+     * Mark a conversation as read
+     */
+    async markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.markReadConversationRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Start a new conversation 
      * Start a conversation

package/src/models/ConversationMessage.ts

@@ -56,6 +56,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     conversation_message_uuid?: string;
+    /**
+     * Delay message transmission until date/time
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    delay_until_dts?: string;
     /**
      * 
      * @type {Array<string>}
@@ -126,6 +132,7 @@ export function ConversationMessageFromJSONTyped(json: any, ignoreDiscriminator:
         'body': !exists(json, 'body') ? undefined : json['body'],
         'client_message_id': !exists(json, 'client_message_id') ? undefined : json['client_message_id'],
         'conversation_message_uuid': !exists(json, 'conversation_message_uuid') ? undefined : json['conversation_message_uuid'],
+        'delay_until_dts': !exists(json, 'delay_until_dts') ? undefined : json['delay_until_dts'],
         'media_urls': !exists(json, 'media_urls') ? undefined : json['media_urls'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
         'message_dts': !exists(json, 'message_dts') ? undefined : json['message_dts'],
@@ -150,6 +157,7 @@ export function ConversationMessageToJSON(value?: ConversationMessage | null): a
         'body': value.body,
         'client_message_id': value.client_message_id,
         'conversation_message_uuid': value.conversation_message_uuid,
+        'delay_until_dts': value.delay_until_dts,
         'media_urls': value.media_urls,
         'merchant_id': value.merchant_id,
         'message_dts': value.message_dts,

package/src/models/OrderItem.ts

@@ -194,6 +194,12 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     height?: Distance;
+    /**
+     * Index of the item on the order (one based index)
+     * @type {number}
+     * @memberof OrderItem
+     */
+    item_index?: number;
     /**
      * Item reference object identifier used to linked to auto order item record
      * @type {number}
@@ -266,6 +272,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     packed_by_user?: string;
+    /**
+     * If this item is a kit component, this is the item index of the parent item (kit)
+     * @type {number}
+     * @memberof OrderItem
+     */
+    parent_item_index?: number;
+    /**
+     * If this item is a kit component, this is the item id of the parent item (kit)
+     * @type {string}
+     * @memberof OrderItem
+     */
+    parent_merchant_item_id?: string;
     /**
      * Perishable class of the item
      * @type {string}
@@ -445,6 +463,7 @@ export function OrderItemFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'free_shipping': !exists(json, 'free_shipping') ? undefined : json['free_shipping'],
         'hazmat': !exists(json, 'hazmat') ? undefined : json['hazmat'],
         'height': !exists(json, 'height') ? undefined : DistanceFromJSON(json['height']),
+        'item_index': !exists(json, 'item_index') ? undefined : json['item_index'],
         'item_reference_oid': !exists(json, 'item_reference_oid') ? undefined : json['item_reference_oid'],
         'kit': !exists(json, 'kit') ? undefined : json['kit'],
         'kit_component': !exists(json, 'kit_component') ? undefined : json['kit_component'],
@@ -457,6 +476,8 @@ export function OrderItemFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'no_shipping_discount': !exists(json, 'no_shipping_discount') ? undefined : json['no_shipping_discount'],
         'options': !exists(json, 'options') ? undefined : ((json['options'] as Array<any>).map(OrderItemOptionFromJSON)),
         'packed_by_user': !exists(json, 'packed_by_user') ? undefined : json['packed_by_user'],
+        'parent_item_index': !exists(json, 'parent_item_index') ? undefined : json['parent_item_index'],
+        'parent_merchant_item_id': !exists(json, 'parent_merchant_item_id') ? undefined : json['parent_merchant_item_id'],
         'perishable_class': !exists(json, 'perishable_class') ? undefined : json['perishable_class'],
         'pricing_tier_name': !exists(json, 'pricing_tier_name') ? undefined : json['pricing_tier_name'],
         'properties': !exists(json, 'properties') ? undefined : ((json['properties'] as Array<any>).map(OrderItemPropertyFromJSON)),
@@ -513,6 +534,7 @@ export function OrderItemToJSON(value?: OrderItem | null): any {
         'free_shipping': value.free_shipping,
         'hazmat': value.hazmat,
         'height': DistanceToJSON(value.height),
+        'item_index': value.item_index,
         'item_reference_oid': value.item_reference_oid,
         'kit': value.kit,
         'kit_component': value.kit_component,
@@ -525,6 +547,8 @@ export function OrderItemToJSON(value?: OrderItem | null): any {
         'no_shipping_discount': value.no_shipping_discount,
         'options': value.options === undefined ? undefined : ((value.options as Array<any>).map(OrderItemOptionToJSON)),
         'packed_by_user': value.packed_by_user,
+        'parent_item_index': value.parent_item_index,
+        'parent_merchant_item_id': value.parent_merchant_item_id,
         'perishable_class': value.perishable_class,
         'pricing_tier_name': value.pricing_tier_name,
         'properties': value.properties === undefined ? undefined : ((value.properties as Array<any>).map(OrderItemPropertyToJSON)),