ultracart_rest_api_v2_typescript 4.1.74 → 4.1.76

package/.openapi-generator/FILES

@@ -7,6 +7,7 @@ src/apis/AutoOrderApi.ts
 src/apis/ChannelPartnerApi.ts
 src/apis/CheckoutApi.ts
 src/apis/ConversationApi.ts
+src/apis/ConversationEmbedApi.ts
 src/apis/CouponApi.ts
 src/apis/CustomerApi.ts
 src/apis/DatawarehouseApi.ts
@@ -175,6 +176,7 @@ src/models/ConversationDepartmentMember.ts
 src/models/ConversationDepartmentMembersResponse.ts
 src/models/ConversationDepartmentResponse.ts
 src/models/ConversationDepartmentsResponse.ts
+src/models/ConversationEmbedPbxAuthResponse.ts
 src/models/ConversationEngagement.ts
 src/models/ConversationEngagementEquation.ts
 src/models/ConversationEngagementEquationFunction.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.74
+## ultracart_rest_api_v2_typescript@4.1.76
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.74 --save
+npm install ultracart_rest_api_v2_typescript@4.1.76 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.76 | 04/17/2026 | conversation - embed oauth methods |
+| 4.1.75 | 04/17/2026 | conversation - embed oauth methods |
 | 4.1.74 | 04/15/2026 | auto order - new method cancelAutoOrderItemByReferenceOrderId |
 | 4.1.73 | 04/13/2026 | conversation pbx - queue configuration for ai summary and call record zoho desk |
 | 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |

package/dist/apis/ConversationEmbedApi.d.ts

@@ -0,0 +1,140 @@
+/**
+ * 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 * as runtime from '../runtime';
+import { ConversationEmbedPbxAuthResponse } from '../models';
+export interface EmbedOauthDeviceAuthorizeRequest {
+    clientId: string;
+    scope: string;
+}
+export interface EmbedOauthRevokeRequest {
+    clientId: string;
+    token: string;
+}
+export interface EmbedOauthTokenRequest {
+    clientId: string;
+    grantType: string;
+    deviceCode?: string;
+    refreshToken?: string;
+}
+/**
+ * ConversationEmbedApi - interface
+ *
+ * @export
+ * @interface ConversationEmbedApiInterface
+ */
+export interface ConversationEmbedApiInterface {
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted.
+     * @summary Initiate a device authorization flow for an embed widget.
+     * @param {string} clientId The embed widget OAuth client_id.
+     * @param {string} scope The application-level scope (must be \\\'crm_embed\\\').
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    embedOauthDeviceAuthorizeRaw(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted.
+     * Initiate a device authorization flow for an embed widget.
+     */
+    embedOauthDeviceAuthorize(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter.
+     * @summary Revoke an embed widget access or refresh token.
+     * @param {string} clientId The embed widget OAuth client_id.
+     * @param {string} token The token to revoke (access token or refresh token).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    embedOauthRevokeRaw(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter.
+     * Revoke an embed widget access or refresh token.
+     */
+    embedOauthRevoke(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
+     * @summary Exchange a device_code or refresh_token for an access token (embed widget).
+     * @param {string} clientId The embed widget OAuth client_id.
+     * @param {string} grantType Grant type.
+     * @param {string} [deviceCode] The device code received from /oauth/device/authorize (required for device_code grant).
+     * @param {string} [refreshToken] The refresh token (required for refresh_token grant).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    embedOauthTokenRaw(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    embedOauthToken(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
+     * @summary Get PBX authorization for the embedded softphone widget.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    getEmbedPbxAuthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEmbedPbxAuthResponse>>;
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    getEmbedPbxAuth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEmbedPbxAuthResponse>;
+}
+/**
+ *
+ */
+export declare class ConversationEmbedApi extends runtime.BaseAPI implements ConversationEmbedApiInterface {
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted.
+     * Initiate a device authorization flow for an embed widget.
+     */
+    embedOauthDeviceAuthorizeRaw(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted.
+     * Initiate a device authorization flow for an embed widget.
+     */
+    embedOauthDeviceAuthorize(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter.
+     * Revoke an embed widget access or refresh token.
+     */
+    embedOauthRevokeRaw(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter.
+     * Revoke an embed widget access or refresh token.
+     */
+    embedOauthRevoke(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    embedOauthTokenRaw(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    embedOauthToken(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    getEmbedPbxAuthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEmbedPbxAuthResponse>>;
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    getEmbedPbxAuth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEmbedPbxAuthResponse>;
+}

package/dist/apis/ConversationEmbedApi.js

@@ -0,0 +1,381 @@
+"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.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationEmbedApi = void 0;
+var runtime = require("../runtime");
+var models_1 = require("../models");
+/**
+ *
+ */
+var ConversationEmbedApi = /** @class */ (function (_super) {
+    __extends(ConversationEmbedApi, _super);
+    function ConversationEmbedApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted.
+     * Initiate a device authorization flow for an embed widget.
+     */
+    ConversationEmbedApi.prototype.embedOauthDeviceAuthorizeRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, consumes, canConsumeForm, formParams, useForm, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
+                            throw new runtime.RequiredError('clientId', 'Required parameter requestParameters.clientId was null or undefined when calling embedOauthDeviceAuthorize.');
+                        }
+                        if (requestParameters.scope === null || requestParameters.scope === undefined) {
+                            throw new runtime.RequiredError('scope', 'Required parameter requestParameters.scope was null or undefined when calling embedOauthDeviceAuthorize.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_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
+                        }
+                        consumes = [
+                            { contentType: 'application/x-www-form-urlencoded' },
+                        ];
+                        canConsumeForm = runtime.canConsumeForm(consumes);
+                        useForm = false;
+                        if (useForm) {
+                            formParams = new FormData();
+                        }
+                        else {
+                            formParams = new URLSearchParams();
+                        }
+                        if (requestParameters.clientId !== undefined) {
+                            formParams.append('client_id', requestParameters.clientId);
+                        }
+                        if (requestParameters.scope !== undefined) {
+                            formParams.append('scope', requestParameters.scope);
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation_embed/oauth/device/authorize",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: formParams,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted.
+     * Initiate a device authorization flow for an embed widget.
+     */
+    ConversationEmbedApi.prototype.embedOauthDeviceAuthorize = 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.embedOauthDeviceAuthorizeRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter.
+     * Revoke an embed widget access or refresh token.
+     */
+    ConversationEmbedApi.prototype.embedOauthRevokeRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, consumes, canConsumeForm, formParams, useForm, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
+                            throw new runtime.RequiredError('clientId', 'Required parameter requestParameters.clientId was null or undefined when calling embedOauthRevoke.');
+                        }
+                        if (requestParameters.token === null || requestParameters.token === undefined) {
+                            throw new runtime.RequiredError('token', 'Required parameter requestParameters.token was null or undefined when calling embedOauthRevoke.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_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
+                        }
+                        consumes = [
+                            { contentType: 'application/x-www-form-urlencoded' },
+                        ];
+                        canConsumeForm = runtime.canConsumeForm(consumes);
+                        useForm = false;
+                        if (useForm) {
+                            formParams = new FormData();
+                        }
+                        else {
+                            formParams = new URLSearchParams();
+                        }
+                        if (requestParameters.clientId !== undefined) {
+                            formParams.append('client_id', requestParameters.clientId);
+                        }
+                        if (requestParameters.token !== undefined) {
+                            formParams.append('token', requestParameters.token);
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation_embed/oauth/device/revoke",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: formParams,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter.
+     * Revoke an embed widget access or refresh token.
+     */
+    ConversationEmbedApi.prototype.embedOauthRevoke = 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.embedOauthRevokeRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    ConversationEmbedApi.prototype.embedOauthTokenRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, consumes, canConsumeForm, formParams, useForm, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
+                            throw new runtime.RequiredError('clientId', 'Required parameter requestParameters.clientId was null or undefined when calling embedOauthToken.');
+                        }
+                        if (requestParameters.grantType === null || requestParameters.grantType === undefined) {
+                            throw new runtime.RequiredError('grantType', 'Required parameter requestParameters.grantType was null or undefined when calling embedOauthToken.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_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
+                        }
+                        consumes = [
+                            { contentType: 'application/x-www-form-urlencoded' },
+                        ];
+                        canConsumeForm = runtime.canConsumeForm(consumes);
+                        useForm = false;
+                        if (useForm) {
+                            formParams = new FormData();
+                        }
+                        else {
+                            formParams = new URLSearchParams();
+                        }
+                        if (requestParameters.clientId !== undefined) {
+                            formParams.append('client_id', requestParameters.clientId);
+                        }
+                        if (requestParameters.grantType !== undefined) {
+                            formParams.append('grant_type', requestParameters.grantType);
+                        }
+                        if (requestParameters.deviceCode !== undefined) {
+                            formParams.append('device_code', requestParameters.deviceCode);
+                        }
+                        if (requestParameters.refreshToken !== undefined) {
+                            formParams.append('refresh_token', requestParameters.refreshToken);
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation_embed/oauth/device/token",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: formParams,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    ConversationEmbedApi.prototype.embedOauthToken = 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.embedOauthTokenRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    ConversationEmbedApi.prototype.getEmbedPbxAuthRaw = 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_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/conversation_embed/pbx-auth",
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationEmbedPbxAuthResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    ConversationEmbedApi.prototype.getEmbedPbxAuth = 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.getEmbedPbxAuthRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return ConversationEmbedApi;
+}(runtime.BaseAPI));
+exports.ConversationEmbedApi = ConversationEmbedApi;

package/dist/apis/index.d.ts

@@ -3,6 +3,7 @@ export * from './AutoOrderApi';
 export * from './ChannelPartnerApi';
 export * from './CheckoutApi';
 export * from './ConversationApi';
+export * from './ConversationEmbedApi';
 export * from './CouponApi';
 export * from './CustomerApi';
 export * from './DatawarehouseApi';

package/dist/apis/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./AutoOrderApi"), exports);
 __exportStar(require("./ChannelPartnerApi"), exports);
 __exportStar(require("./CheckoutApi"), exports);
 __exportStar(require("./ConversationApi"), exports);
+__exportStar(require("./ConversationEmbedApi"), exports);
 __exportStar(require("./CouponApi"), exports);
 __exportStar(require("./CustomerApi"), exports);
 __exportStar(require("./DatawarehouseApi"), exports);

package/dist/models/ConversationEmbedPbxAuthResponse.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 ConversationEmbedPbxAuthResponse
+ */
+export interface ConversationEmbedPbxAuthResponse {
+    /**
+     * Merchant identifier the agent belongs to.
+     * @type {string}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    merchant_id?: string;
+    /**
+     * True if this agent has PBX admin privileges.
+     * @type {boolean}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_admin?: boolean;
+    /**
+     * JWT used by the softphone widget to authenticate to the PBX WebSocket relay.
+     * @type {string}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_jwt?: string;
+    /**
+     * True if this agent has PBX supervisor privileges.
+     * @type {boolean}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_supervisor?: boolean;
+    /**
+     * True if this agent has baseline PBX access.
+     * @type {boolean}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_user?: boolean;
+    /**
+     * Voice identity string identifying this agent to the PBX (e.g., client:user_123).
+     * @type {string}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_voice_identity?: string;
+}
+/**
+ * Check if a given object implements the ConversationEmbedPbxAuthResponse interface.
+ */
+export declare function instanceOfConversationEmbedPbxAuthResponse(value: object): boolean;
+export declare function ConversationEmbedPbxAuthResponseFromJSON(json: any): ConversationEmbedPbxAuthResponse;
+export declare function ConversationEmbedPbxAuthResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEmbedPbxAuthResponse;
+export declare function ConversationEmbedPbxAuthResponseToJSON(value?: ConversationEmbedPbxAuthResponse | null): any;

package/dist/models/ConversationEmbedPbxAuthResponse.js

@@ -0,0 +1,60 @@
+"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.ConversationEmbedPbxAuthResponseToJSON = exports.ConversationEmbedPbxAuthResponseFromJSONTyped = exports.ConversationEmbedPbxAuthResponseFromJSON = exports.instanceOfConversationEmbedPbxAuthResponse = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the ConversationEmbedPbxAuthResponse interface.
+ */
+function instanceOfConversationEmbedPbxAuthResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationEmbedPbxAuthResponse = instanceOfConversationEmbedPbxAuthResponse;
+function ConversationEmbedPbxAuthResponseFromJSON(json) {
+    return ConversationEmbedPbxAuthResponseFromJSONTyped(json, false);
+}
+exports.ConversationEmbedPbxAuthResponseFromJSON = ConversationEmbedPbxAuthResponseFromJSON;
+function ConversationEmbedPbxAuthResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'pbx_admin': !(0, runtime_1.exists)(json, 'pbx_admin') ? undefined : json['pbx_admin'],
+        'pbx_jwt': !(0, runtime_1.exists)(json, 'pbx_jwt') ? undefined : json['pbx_jwt'],
+        'pbx_supervisor': !(0, runtime_1.exists)(json, 'pbx_supervisor') ? undefined : json['pbx_supervisor'],
+        'pbx_user': !(0, runtime_1.exists)(json, 'pbx_user') ? undefined : json['pbx_user'],
+        'pbx_voice_identity': !(0, runtime_1.exists)(json, 'pbx_voice_identity') ? undefined : json['pbx_voice_identity'],
+    };
+}
+exports.ConversationEmbedPbxAuthResponseFromJSONTyped = ConversationEmbedPbxAuthResponseFromJSONTyped;
+function ConversationEmbedPbxAuthResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'merchant_id': value.merchant_id,
+        'pbx_admin': value.pbx_admin,
+        'pbx_jwt': value.pbx_jwt,
+        'pbx_supervisor': value.pbx_supervisor,
+        'pbx_user': value.pbx_user,
+        'pbx_voice_identity': value.pbx_voice_identity,
+    };
+}
+exports.ConversationEmbedPbxAuthResponseToJSON = ConversationEmbedPbxAuthResponseToJSON;

package/dist/models/index.d.ts

@@ -149,6 +149,7 @@ export * from './ConversationDepartmentMember';
 export * from './ConversationDepartmentMembersResponse';
 export * from './ConversationDepartmentResponse';
 export * from './ConversationDepartmentsResponse';
+export * from './ConversationEmbedPbxAuthResponse';
 export * from './ConversationEngagement';
 export * from './ConversationEngagementEquation';
 export * from './ConversationEngagementEquationFunction';

package/dist/models/index.js

@@ -167,6 +167,7 @@ __exportStar(require("./ConversationDepartmentMember"), exports);
 __exportStar(require("./ConversationDepartmentMembersResponse"), exports);
 __exportStar(require("./ConversationDepartmentResponse"), exports);
 __exportStar(require("./ConversationDepartmentsResponse"), exports);
+__exportStar(require("./ConversationEmbedPbxAuthResponse"), exports);
 __exportStar(require("./ConversationEngagement"), exports);
 __exportStar(require("./ConversationEngagementEquation"), exports);
 __exportStar(require("./ConversationEngagementEquationFunction"), exports);

package/package.json

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

package/src/apis/ConversationEmbedApi.ts

@@ -0,0 +1,379 @@
+/* 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 * as runtime from '../runtime';
+import {
+    ConversationEmbedPbxAuthResponse,
+    ConversationEmbedPbxAuthResponseFromJSON,
+    ConversationEmbedPbxAuthResponseToJSON,
+    ErrorResponse,
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+} from '../models';
+
+export interface EmbedOauthDeviceAuthorizeRequest {
+    clientId: string;
+    scope: string;
+}
+
+export interface EmbedOauthRevokeRequest {
+    clientId: string;
+    token: string;
+}
+
+export interface EmbedOauthTokenRequest {
+    clientId: string;
+    grantType: string;
+    deviceCode?: string;
+    refreshToken?: string;
+}
+
+/**
+ * ConversationEmbedApi - interface
+ * 
+ * @export
+ * @interface ConversationEmbedApiInterface
+ */
+export interface ConversationEmbedApiInterface {
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted. 
+     * @summary Initiate a device authorization flow for an embed widget.
+     * @param {string} clientId The embed widget OAuth client_id.
+     * @param {string} scope The application-level scope (must be \\\'crm_embed\\\').
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    embedOauthDeviceAuthorizeRaw(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted. 
+     * Initiate a device authorization flow for an embed widget.
+     */
+    embedOauthDeviceAuthorize(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter. 
+     * @summary Revoke an embed widget access or refresh token.
+     * @param {string} clientId The embed widget OAuth client_id.
+     * @param {string} token The token to revoke (access token or refresh token).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    embedOauthRevokeRaw(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter. 
+     * Revoke an embed widget access or refresh token.
+     */
+    embedOauthRevoke(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes. 
+     * @summary Exchange a device_code or refresh_token for an access token (embed widget).
+     * @param {string} clientId The embed widget OAuth client_id.
+     * @param {string} grantType Grant type.
+     * @param {string} [deviceCode] The device code received from /oauth/device/authorize (required for device_code grant).
+     * @param {string} [refreshToken] The refresh token (required for refresh_token grant).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    embedOauthTokenRaw(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes. 
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    embedOauthToken(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded. 
+     * @summary Get PBX authorization for the embedded softphone widget.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationEmbedApiInterface
+     */
+    getEmbedPbxAuthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEmbedPbxAuthResponse>>;
+
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded. 
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    getEmbedPbxAuth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEmbedPbxAuthResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ConversationEmbedApi extends runtime.BaseAPI implements ConversationEmbedApiInterface {
+
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted. 
+     * Initiate a device authorization flow for an embed widget.
+     */
+    async embedOauthDeviceAuthorizeRaw(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
+            throw new runtime.RequiredError('clientId','Required parameter requestParameters.clientId was null or undefined when calling embedOauthDeviceAuthorize.');
+        }
+
+        if (requestParameters.scope === null || requestParameters.scope === undefined) {
+            throw new runtime.RequiredError('scope','Required parameter requestParameters.scope was null or undefined when calling embedOauthDeviceAuthorize.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters.clientId !== undefined) {
+            formParams.append('client_id', requestParameters.clientId as any);
+        }
+
+        if (requestParameters.scope !== undefined) {
+            formParams.append('scope', requestParameters.scope as any);
+        }
+
+        const response = await this.request({
+            path: `/conversation_embed/oauth/device/authorize`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * RFC 8628 device authorization. Only the embed widget\'s client_id and the crm_embed scope are accepted. 
+     * Initiate a device authorization flow for an embed widget.
+     */
+    async embedOauthDeviceAuthorize(requestParameters: EmbedOauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.embedOauthDeviceAuthorizeRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter. 
+     * Revoke an embed widget access or refresh token.
+     */
+    async embedOauthRevokeRaw(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
+            throw new runtime.RequiredError('clientId','Required parameter requestParameters.clientId was null or undefined when calling embedOauthRevoke.');
+        }
+
+        if (requestParameters.token === null || requestParameters.token === undefined) {
+            throw new runtime.RequiredError('token','Required parameter requestParameters.token was null or undefined when calling embedOauthRevoke.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters.clientId !== undefined) {
+            formParams.append('client_id', requestParameters.clientId as any);
+        }
+
+        if (requestParameters.token !== undefined) {
+            formParams.append('token', requestParameters.token as any);
+        }
+
+        const response = await this.request({
+            path: `/conversation_embed/oauth/device/revoke`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the \'token\' parameter. 
+     * Revoke an embed widget access or refresh token.
+     */
+    async embedOauthRevoke(requestParameters: EmbedOauthRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.embedOauthRevokeRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes. 
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    async embedOauthTokenRaw(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
+            throw new runtime.RequiredError('clientId','Required parameter requestParameters.clientId was null or undefined when calling embedOauthToken.');
+        }
+
+        if (requestParameters.grantType === null || requestParameters.grantType === undefined) {
+            throw new runtime.RequiredError('grantType','Required parameter requestParameters.grantType was null or undefined when calling embedOauthToken.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters.clientId !== undefined) {
+            formParams.append('client_id', requestParameters.clientId as any);
+        }
+
+        if (requestParameters.grantType !== undefined) {
+            formParams.append('grant_type', requestParameters.grantType as any);
+        }
+
+        if (requestParameters.deviceCode !== undefined) {
+            formParams.append('device_code', requestParameters.deviceCode as any);
+        }
+
+        if (requestParameters.refreshToken !== undefined) {
+            formParams.append('refresh_token', requestParameters.refreshToken as any);
+        }
+
+        const response = await this.request({
+            path: `/conversation_embed/oauth/device/token`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes. 
+     * Exchange a device_code or refresh_token for an access token (embed widget).
+     */
+    async embedOauthToken(requestParameters: EmbedOauthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.embedOauthTokenRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded. 
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    async getEmbedPbxAuthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEmbedPbxAuthResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
+        }
+
+        const response = await this.request({
+            path: `/conversation_embed/pbx-auth`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationEmbedPbxAuthResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded. 
+     * Get PBX authorization for the embedded softphone widget.
+     */
+    async getEmbedPbxAuth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEmbedPbxAuthResponse> {
+        const response = await this.getEmbedPbxAuthRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -5,6 +5,7 @@ export * from './AutoOrderApi';
 export * from './ChannelPartnerApi';
 export * from './CheckoutApi';
 export * from './ConversationApi';
+export * from './ConversationEmbedApi';
 export * from './CouponApi';
 export * from './CustomerApi';
 export * from './DatawarehouseApi';

package/src/models/ConversationEmbedPbxAuthResponse.ts

@@ -0,0 +1,107 @@
+/* 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 ConversationEmbedPbxAuthResponse
+ */
+export interface ConversationEmbedPbxAuthResponse {
+    /**
+     * Merchant identifier the agent belongs to.
+     * @type {string}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    merchant_id?: string;
+    /**
+     * True if this agent has PBX admin privileges.
+     * @type {boolean}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_admin?: boolean;
+    /**
+     * JWT used by the softphone widget to authenticate to the PBX WebSocket relay.
+     * @type {string}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_jwt?: string;
+    /**
+     * True if this agent has PBX supervisor privileges.
+     * @type {boolean}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_supervisor?: boolean;
+    /**
+     * True if this agent has baseline PBX access.
+     * @type {boolean}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_user?: boolean;
+    /**
+     * Voice identity string identifying this agent to the PBX (e.g., client:user_123).
+     * @type {string}
+     * @memberof ConversationEmbedPbxAuthResponse
+     */
+    pbx_voice_identity?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ConversationEmbedPbxAuthResponse interface.
+ */
+export function instanceOfConversationEmbedPbxAuthResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ConversationEmbedPbxAuthResponseFromJSON(json: any): ConversationEmbedPbxAuthResponse {
+    return ConversationEmbedPbxAuthResponseFromJSONTyped(json, false);
+}
+
+export function ConversationEmbedPbxAuthResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEmbedPbxAuthResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'pbx_admin': !exists(json, 'pbx_admin') ? undefined : json['pbx_admin'],
+        'pbx_jwt': !exists(json, 'pbx_jwt') ? undefined : json['pbx_jwt'],
+        'pbx_supervisor': !exists(json, 'pbx_supervisor') ? undefined : json['pbx_supervisor'],
+        'pbx_user': !exists(json, 'pbx_user') ? undefined : json['pbx_user'],
+        'pbx_voice_identity': !exists(json, 'pbx_voice_identity') ? undefined : json['pbx_voice_identity'],
+    };
+}
+
+export function ConversationEmbedPbxAuthResponseToJSON(value?: ConversationEmbedPbxAuthResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'merchant_id': value.merchant_id,
+        'pbx_admin': value.pbx_admin,
+        'pbx_jwt': value.pbx_jwt,
+        'pbx_supervisor': value.pbx_supervisor,
+        'pbx_user': value.pbx_user,
+        'pbx_voice_identity': value.pbx_voice_identity,
+    };
+}
+

package/src/models/index.ts

@@ -151,6 +151,7 @@ export * from './ConversationDepartmentMember';
 export * from './ConversationDepartmentMembersResponse';
 export * from './ConversationDepartmentResponse';
 export * from './ConversationDepartmentsResponse';
+export * from './ConversationEmbedPbxAuthResponse';
 export * from './ConversationEngagement';
 export * from './ConversationEngagementEquation';
 export * from './ConversationEngagementEquationFunction';