ultracart_rest_api_v2_typescript 4.0.134 → 4.0.135

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.134
+## ultracart_rest_api_v2_typescript@4.0.135
 
 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.134 --save
+npm install ultracart_rest_api_v2_typescript@4.0.135 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |
 | 4.0.132 | 02/07/2023 | convo - new event for when a customer joins a queue |

package/dist/apis/ConversationApi.d.ts

@@ -72,6 +72,9 @@ export interface MarkReadConversationRequest {
 export interface SearchConversationCannedMessagesRequest {
     searchRequest: ConversationCannedMessagesSearch;
 }
+export interface SmsUnsubscribeConversationRequest {
+    conversationUuid: string;
+}
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
@@ -490,6 +493,20 @@ export interface ConversationApiInterface {
      * Search for canned messages by short_code
      */
     searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversationUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    smsUnsubscribeConversationRaw(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * Unsubscribe any SMS participants in this conversation
+     */
+    smsUnsubscribeConversation(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -863,6 +880,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Search for canned messages by short_code
      */
     searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * Unsubscribe any SMS participants in this conversation
+     */
+    smsUnsubscribeConversationRaw(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * Unsubscribe any SMS participants in this conversation
+     */
+    smsUnsubscribeConversation(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Start a new conversation
      * Start a conversation

package/dist/apis/ConversationApi.js

@@ -1716,6 +1716,63 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * Unsubscribe any SMS participants in this conversation
+     */
+    ConversationApi.prototype.smsUnsubscribeConversationRaw = 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 smsUnsubscribeConversation.');
+                        }
+                        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}/sms_unsubscribe".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)];
+                }
+            });
+        });
+    };
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * Unsubscribe any SMS participants in this conversation
+     */
+    ConversationApi.prototype.smsUnsubscribeConversation = 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.smsUnsubscribeConversationRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Start a new conversation
      * Start a conversation

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -189,6 +189,10 @@ export interface SearchConversationCannedMessagesRequest {
     searchRequest: ConversationCannedMessagesSearch;
 }
 
+export interface SmsUnsubscribeConversationRequest {
+    conversationUuid: string;
+}
+
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
@@ -669,6 +673,22 @@ export interface ConversationApiInterface {
      */
     searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
 
+    /**
+     * Unsubscribe any SMS participants in this conversation 
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversationUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    smsUnsubscribeConversationRaw(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Unsubscribe any SMS participants in this conversation 
+     * Unsubscribe any SMS participants in this conversation
+     */
+    smsUnsubscribeConversation(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * Start a new conversation 
      * @summary Start a conversation
@@ -1922,6 +1942,46 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Unsubscribe any SMS participants in this conversation 
+     * Unsubscribe any SMS participants in this conversation
+     */
+    async smsUnsubscribeConversationRaw(requestParameters: SmsUnsubscribeConversationRequest, 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 smsUnsubscribeConversation.');
+        }
+
+        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}/sms_unsubscribe`.replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(requestParameters.conversationUuid))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Unsubscribe any SMS participants in this conversation 
+     * Unsubscribe any SMS participants in this conversation
+     */
+    async smsUnsubscribeConversation(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.smsUnsubscribeConversationRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Start a new conversation 
      * Start a conversation