ultracart_rest_api_v2_typescript 4.0.117-RC → 4.0.118-RC

package/.openapi-generator/FILES

@@ -158,6 +158,7 @@ src/models/ConversationCannedMessagesResponse.ts
 src/models/ConversationCannedMessagesSearch.ts
 src/models/ConversationDepartment.ts
 src/models/ConversationDepartmentMember.ts
+src/models/ConversationDepartmentMembersResponse.ts
 src/models/ConversationDepartmentResponse.ts
 src/models/ConversationDepartmentsResponse.ts
 src/models/ConversationEngagement.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.117-RC
+## ultracart_rest_api_v2_typescript@4.0.118-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.117-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.118-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.118-RC | 01/18/2023 | conversation get dept member list method added |
 | 4.0.117-RC | 01/18/2023 | conversation dept members |
 | 4.0.116-RC | 01/18/2023 | channel partner ship to pref desc field |
 | 4.0.115-RC | 01/17/2023 | changed convo webchat constant |

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { ConversationAgentAuthResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
+import { ConversationAgentAuthResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
 export interface DeleteConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
 }
@@ -205,6 +205,19 @@ export interface ConversationApiInterface {
      * Get a webchat conversation context
      */
     getConversationContext(requestParameters: GetConversationContextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationWebchatContext>;
+    /**
+     * Retrieve a list of possible department members
+     * @summary Retrieve a list of possible department members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationDepartmentMemberListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentMembersResponse>>;
+    /**
+     * Retrieve a list of possible department members
+     * Retrieve a list of possible department members
+     */
+    getConversationDepartmentMemberList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentMembersResponse>;
     /**
      * Retrieve a list of departments ordered by name
      * @summary Retrieve a list of departments ordered by name
@@ -577,6 +590,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Get a webchat conversation context
      */
     getConversationContext(requestParameters: GetConversationContextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationWebchatContext>;
+    /**
+     * Retrieve a list of possible department members
+     * Retrieve a list of possible department members
+     */
+    getConversationDepartmentMemberListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentMembersResponse>>;
+    /**
+     * Retrieve a list of possible department members
+     * Retrieve a list of possible department members
+     */
+    getConversationDepartmentMemberList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentMembersResponse>;
     /**
      * Retrieve a list of departments ordered by name
      * Retrieve a list of departments ordered by name

package/dist/apis/ConversationApi.js

@@ -533,6 +533,62 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve a list of possible department members
+     * Retrieve a list of possible department members
+     */
+    ConversationApi.prototype.getConversationDepartmentMemberListRaw = function (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:
+                        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/department_members",
+                                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.ConversationDepartmentMembersResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve a list of possible department members
+     * Retrieve a list of possible department members
+     */
+    ConversationApi.prototype.getConversationDepartmentMemberList = function (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.getConversationDepartmentMemberListRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a list of departments ordered by name
      * Retrieve a list of departments ordered by name

package/dist/models/ConversationDepartmentMembersResponse.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 { ConversationDepartmentMember } from './ConversationDepartmentMember';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface ConversationDepartmentMembersResponse
+ */
+export interface ConversationDepartmentMembersResponse {
+    /**
+     *
+     * @type {Array<ConversationDepartmentMember>}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    conversation_department_members?: Array<ConversationDepartmentMember>;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    warning?: Warning;
+}
+export declare function ConversationDepartmentMembersResponseFromJSON(json: any): ConversationDepartmentMembersResponse;
+export declare function ConversationDepartmentMembersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationDepartmentMembersResponse;
+export declare function ConversationDepartmentMembersResponseToJSON(value?: ConversationDepartmentMembersResponse | null): any;

package/dist/models/ConversationDepartmentMembersResponse.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.ConversationDepartmentMembersResponseToJSON = exports.ConversationDepartmentMembersResponseFromJSONTyped = exports.ConversationDepartmentMembersResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ConversationDepartmentMember_1 = require("./ConversationDepartmentMember");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function ConversationDepartmentMembersResponseFromJSON(json) {
+    return ConversationDepartmentMembersResponseFromJSONTyped(json, false);
+}
+exports.ConversationDepartmentMembersResponseFromJSON = ConversationDepartmentMembersResponseFromJSON;
+function ConversationDepartmentMembersResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'conversation_department_members': !(0, runtime_1.exists)(json, 'conversation_department_members') ? undefined : (json['conversation_department_members'].map(ConversationDepartmentMember_1.ConversationDepartmentMemberFromJSON)),
+        '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.ConversationDepartmentMembersResponseFromJSONTyped = ConversationDepartmentMembersResponseFromJSONTyped;
+function ConversationDepartmentMembersResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'conversation_department_members': value.conversation_department_members === undefined ? undefined : (value.conversation_department_members.map(ConversationDepartmentMember_1.ConversationDepartmentMemberToJSON)),
+        '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.ConversationDepartmentMembersResponseToJSON = ConversationDepartmentMembersResponseToJSON;

package/dist/models/index.d.ts

@@ -133,6 +133,7 @@ export * from './ConversationCannedMessagesResponse';
 export * from './ConversationCannedMessagesSearch';
 export * from './ConversationDepartment';
 export * from './ConversationDepartmentMember';
+export * from './ConversationDepartmentMembersResponse';
 export * from './ConversationDepartmentResponse';
 export * from './ConversationDepartmentsResponse';
 export * from './ConversationEngagement';

package/dist/models/index.js

@@ -151,6 +151,7 @@ __exportStar(require("./ConversationCannedMessagesResponse"), exports);
 __exportStar(require("./ConversationCannedMessagesSearch"), exports);
 __exportStar(require("./ConversationDepartment"), exports);
 __exportStar(require("./ConversationDepartmentMember"), exports);
+__exportStar(require("./ConversationDepartmentMembersResponse"), exports);
 __exportStar(require("./ConversationDepartmentResponse"), exports);
 __exportStar(require("./ConversationDepartmentsResponse"), exports);
 __exportStar(require("./ConversationEngagement"), exports);

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -39,6 +39,9 @@ import {
     ConversationDepartment,
     ConversationDepartmentFromJSON,
     ConversationDepartmentToJSON,
+    ConversationDepartmentMembersResponse,
+    ConversationDepartmentMembersResponseFromJSON,
+    ConversationDepartmentMembersResponseToJSON,
     ConversationDepartmentResponse,
     ConversationDepartmentResponseFromJSON,
     ConversationDepartmentResponseToJSON,
@@ -327,6 +330,21 @@ export interface ConversationApiInterface {
      */
     getConversationContext(requestParameters: GetConversationContextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationWebchatContext>;
 
+    /**
+     * Retrieve a list of possible department members 
+     * @summary Retrieve a list of possible department members
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationDepartmentMemberListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentMembersResponse>>;
+
+    /**
+     * Retrieve a list of possible department members 
+     * Retrieve a list of possible department members
+     */
+    getConversationDepartmentMemberList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentMembersResponse>;
+
     /**
      * Retrieve a list of departments ordered by name 
      * @summary Retrieve a list of departments ordered by name
@@ -977,6 +995,43 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Retrieve a list of possible department members 
+     * Retrieve a list of possible department members
+     */
+    async getConversationDepartmentMemberListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentMembersResponse>> {
+        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/department_members`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationDepartmentMembersResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a list of possible department members 
+     * Retrieve a list of possible department members
+     */
+    async getConversationDepartmentMemberList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentMembersResponse> {
+        const response = await this.getConversationDepartmentMemberListRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a list of departments ordered by name 
      * Retrieve a list of departments ordered by name

package/src/models/ConversationDepartmentMembersResponse.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 {
+    ConversationDepartmentMember,
+    ConversationDepartmentMemberFromJSON,
+    ConversationDepartmentMemberFromJSONTyped,
+    ConversationDepartmentMemberToJSON,
+} from './ConversationDepartmentMember';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface ConversationDepartmentMembersResponse
+ */
+export interface ConversationDepartmentMembersResponse {
+    /**
+     * 
+     * @type {Array<ConversationDepartmentMember>}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    conversation_department_members?: Array<ConversationDepartmentMember>;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationDepartmentMembersResponse
+     */
+    warning?: Warning;
+}
+
+export function ConversationDepartmentMembersResponseFromJSON(json: any): ConversationDepartmentMembersResponse {
+    return ConversationDepartmentMembersResponseFromJSONTyped(json, false);
+}
+
+export function ConversationDepartmentMembersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationDepartmentMembersResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'conversation_department_members': !exists(json, 'conversation_department_members') ? undefined : ((json['conversation_department_members'] as Array<any>).map(ConversationDepartmentMemberFromJSON)),
+        '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 ConversationDepartmentMembersResponseToJSON(value?: ConversationDepartmentMembersResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'conversation_department_members': value.conversation_department_members === undefined ? undefined : ((value.conversation_department_members as Array<any>).map(ConversationDepartmentMemberToJSON)),
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -135,6 +135,7 @@ export * from './ConversationCannedMessagesResponse';
 export * from './ConversationCannedMessagesSearch';
 export * from './ConversationDepartment';
 export * from './ConversationDepartmentMember';
+export * from './ConversationDepartmentMembersResponse';
 export * from './ConversationDepartmentResponse';
 export * from './ConversationDepartmentsResponse';
 export * from './ConversationEngagement';