ultracart_api 4.1.74 → 4.1.77

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '048bade7fa9ab06961ade9e258cb951517885d69a10c17bb16afd5da671f5f8e'
-  data.tar.gz: 2ceeac92a4b38fd71ea6184c324bf67a85697bf4b8fa438eba08c72c73c952d0
+  metadata.gz: b7ed4def4059749d557efdd0c5c5dd90a7eb112e5250f75bedcd58a6651b248f
+  data.tar.gz: 7413b440e4ea11c3a12e60c441c46e95c6a557ee8e90b7071c629eca07b9f503
 SHA512:
-  metadata.gz: a8be31cc04399ffb7792f0b217d404e0112bd5bdb3c82ea28315bbc4077c6246328a032687765b591d20e69c2f15926f0de600a75cac5ce91606e3625ea841fd
-  data.tar.gz: ac811d895523f9de813b4e3a77a8696e5f2dbc1d90ff9ba6a11d550884c54b61c765d07d6dbbadc76562fb5ba7b210f71c0d2e5d711485ad9b291c161ee36f1c
+  metadata.gz: e9214ab58181126f9f28f426d9d4b9f12dcc0c125dda7d24e1d55f6cf1d4637928cef4f1db2133123e021e2a0c027e98fec82441864a8a6a94136ded097f6494
+  data.tar.gz: 94ece6c1560a2159c9801a8e34e72e37abebefa5c6e5b1116bb8592ba1d3b457b356b2c3d04e9540c7d562663ed9586005a04fec0d3332f5265d84a1f7fc2649

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.74
+- Package version: 4.1.77
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.74'
+gem 'ultracart_api', '4.1.77'
 ```
 
 install:
@@ -262,6 +262,10 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**update_user_pbx_audio**](docs/ConversationApi.md#update_user_pbx_audio) | **PUT** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Update user pbx audio
 *UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
 *UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
+*UltracartClient::ConversationEmbedApi* | [**embed_oauth_device_authorize**](docs/ConversationEmbedApi.md#embed_oauth_device_authorize) | **POST** /conversation_embed/oauth/device/authorize | Initiate a device authorization flow for an embed widget.
+*UltracartClient::ConversationEmbedApi* | [**embed_oauth_revoke**](docs/ConversationEmbedApi.md#embed_oauth_revoke) | **POST** /conversation_embed/oauth/device/revoke | Revoke an embed widget access or refresh token.
+*UltracartClient::ConversationEmbedApi* | [**embed_oauth_token**](docs/ConversationEmbedApi.md#embed_oauth_token) | **POST** /conversation_embed/oauth/device/token | Exchange a device_code or refresh_token for an access token (embed widget).
+*UltracartClient::ConversationEmbedApi* | [**get_embed_pbx_auth**](docs/ConversationEmbedApi.md#get_embed_pbx_auth) | **PUT** /conversation_embed/pbx-auth | Get PBX authorization for the embedded softphone widget.
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
 *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
 *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -815,6 +819,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationDepartmentMembersResponse](docs/ConversationDepartmentMembersResponse.md)
  - [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
  - [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
+ - [UltracartClient::ConversationEmbedPbxAuthResponse](docs/ConversationEmbedPbxAuthResponse.md)
  - [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
  - [UltracartClient::ConversationEngagementEquation](docs/ConversationEngagementEquation.md)
  - [UltracartClient::ConversationEngagementEquationFunction](docs/ConversationEngagementEquationFunction.md)
@@ -1692,6 +1697,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.77 | 04/17/2026 | conversation - embed oauth methods |
+| 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 |

data/docs/ConversationEmbedApi.md

@@ -0,0 +1,226 @@
+# UltracartClient::ConversationEmbedApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**embed_oauth_device_authorize**](ConversationEmbedApi.md#embed_oauth_device_authorize) | **POST** /conversation_embed/oauth/device/authorize | Initiate a device authorization flow for an embed widget. |
+| [**embed_oauth_revoke**](ConversationEmbedApi.md#embed_oauth_revoke) | **POST** /conversation_embed/oauth/device/revoke | Revoke an embed widget access or refresh token. |
+| [**embed_oauth_token**](ConversationEmbedApi.md#embed_oauth_token) | **POST** /conversation_embed/oauth/device/token | Exchange a device_code or refresh_token for an access token (embed widget). |
+| [**get_embed_pbx_auth**](ConversationEmbedApi.md#get_embed_pbx_auth) | **PUT** /conversation_embed/pbx-auth | Get PBX authorization for the embedded softphone widget. |
+
+
+## embed_oauth_device_authorize
+
+> embed_oauth_device_authorize(client_id, scope)
+
+Initiate a device authorization flow for an embed widget.
+
+RFC 8628 device authorization. Only the embed widget's client_id and the crm_embed scope are accepted. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the embed_oauth_device_authorize_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> embed_oauth_device_authorize_with_http_info(client_id, scope)
+
+```ruby
+begin
+  # Initiate a device authorization flow for an embed widget.
+  data, status_code, headers = api_instance.embed_oauth_device_authorize_with_http_info(client_id, scope)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationEmbedApi->embed_oauth_device_authorize_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The embed widget OAuth client_id. |  |
+| **scope** | **String** | The application-level scope (must be &#39;crm_embed&#39;). |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## embed_oauth_revoke
+
+> embed_oauth_revoke(client_id, token)
+
+Revoke an embed widget access or refresh token.
+
+RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the 'token' parameter. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the embed_oauth_revoke_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> embed_oauth_revoke_with_http_info(client_id, token)
+
+```ruby
+begin
+  # Revoke an embed widget access or refresh token.
+  data, status_code, headers = api_instance.embed_oauth_revoke_with_http_info(client_id, token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationEmbedApi->embed_oauth_revoke_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The embed widget OAuth client_id. |  |
+| **token** | **String** | The token to revoke (access token or refresh token). |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## embed_oauth_token
+
+> embed_oauth_token(client_id, grant_type, opts)
+
+Exchange a device_code or refresh_token for an access token (embed widget).
+
+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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the embed_oauth_token_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> embed_oauth_token_with_http_info(client_id, grant_type, opts)
+
+```ruby
+begin
+  # Exchange a device_code or refresh_token for an access token (embed widget).
+  data, status_code, headers = api_instance.embed_oauth_token_with_http_info(client_id, grant_type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationEmbedApi->embed_oauth_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The embed widget OAuth client_id. |  |
+| **grant_type** | **String** | Grant type. |  |
+| **device_code** | **String** | The device code received from /oauth/device/authorize (required for device_code grant). | [optional] |
+| **refresh_token** | **String** | The refresh token (required for refresh_token grant). | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## get_embed_pbx_auth
+
+> <ConversationEmbedPbxAuthResponse> get_embed_pbx_auth
+
+Get PBX authorization for the embedded softphone widget.
+
+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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_embed_pbx_auth_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationEmbedPbxAuthResponse>, Integer, Hash)> get_embed_pbx_auth_with_http_info
+
+```ruby
+begin
+  # Get PBX authorization for the embedded softphone widget.
+  data, status_code, headers = api_instance.get_embed_pbx_auth_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationEmbedPbxAuthResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationEmbedApi->get_embed_pbx_auth_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationEmbedPbxAuthResponse**](ConversationEmbedPbxAuthResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ConversationEmbedPbxAuthResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationEmbedPbxAuthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_id** | **String** | Merchant identifier the agent belongs to. | [optional] |
+| **pbx_admin** | **Boolean** | True if this agent has PBX admin privileges. | [optional] |
+| **pbx_jwt** | **String** | JWT used by the softphone widget to authenticate to the PBX WebSocket relay. | [optional] |
+| **pbx_supervisor** | **Boolean** | True if this agent has PBX supervisor privileges. | [optional] |
+| **pbx_user** | **Boolean** | True if this agent has baseline PBX access. | [optional] |
+| **pbx_voice_identity** | **String** | Voice identity string identifying this agent to the PBX (e.g., client:user_123). | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationEmbedPbxAuthResponse.new(
+  merchant_id: null,
+  pbx_admin: null,
+  pbx_jwt: null,
+  pbx_supervisor: null,
+  pbx_user: null,
+  pbx_voice_identity: null
+)
+```
+

data/lib/ultracart_api/api/conversation_embed_api.rb

@@ -0,0 +1,330 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module UltracartClient
+  class ConversationEmbedApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::ConversationEmbedApi.new(api_client)
+    end
+
+    # Initiate a device authorization flow for an embed widget.
+    # RFC 8628 device authorization. Only the embed widget's client_id and the crm_embed scope are accepted. 
+    # @param client_id [String] The embed widget OAuth client_id.
+    # @param scope [String] The application-level scope (must be 'crm_embed').
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def embed_oauth_device_authorize(client_id, scope, opts = {})
+      embed_oauth_device_authorize_with_http_info(client_id, scope, opts)
+      nil
+    end
+
+    # Initiate a device authorization flow for an embed widget.
+    # RFC 8628 device authorization. Only the embed widget's client_id and the crm_embed scope are accepted. 
+    # @param client_id [String] The embed widget OAuth client_id.
+    # @param scope [String] The application-level scope (must be 'crm_embed').
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def embed_oauth_device_authorize_with_http_info(client_id, scope, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationEmbedApi.embed_oauth_device_authorize ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling ConversationEmbedApi.embed_oauth_device_authorize"
+      end
+      # verify the required parameter 'scope' is set
+      if @api_client.config.client_side_validation && scope.nil?
+        fail ArgumentError, "Missing the required parameter 'scope' when calling ConversationEmbedApi.embed_oauth_device_authorize"
+      end
+      # resource path
+      local_var_path = '/conversation_embed/oauth/device/authorize'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['client_id'] = client_id
+      form_params['scope'] = scope
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationEmbedApi.embed_oauth_device_authorize",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationEmbedApi#embed_oauth_device_authorize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke an embed widget access or refresh token.
+    # RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the 'token' parameter. 
+    # @param client_id [String] The embed widget OAuth client_id.
+    # @param token [String] The token to revoke (access token or refresh token).
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def embed_oauth_revoke(client_id, token, opts = {})
+      embed_oauth_revoke_with_http_info(client_id, token, opts)
+      nil
+    end
+
+    # Revoke an embed widget access or refresh token.
+    # RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the &#39;token&#39; parameter. 
+    # @param client_id [String] The embed widget OAuth client_id.
+    # @param token [String] The token to revoke (access token or refresh token).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def embed_oauth_revoke_with_http_info(client_id, token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationEmbedApi.embed_oauth_revoke ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling ConversationEmbedApi.embed_oauth_revoke"
+      end
+      # verify the required parameter 'token' is set
+      if @api_client.config.client_side_validation && token.nil?
+        fail ArgumentError, "Missing the required parameter 'token' when calling ConversationEmbedApi.embed_oauth_revoke"
+      end
+      # resource path
+      local_var_path = '/conversation_embed/oauth/device/revoke'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['client_id'] = client_id
+      form_params['token'] = token
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationEmbedApi.embed_oauth_revoke",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationEmbedApi#embed_oauth_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Exchange a device_code or refresh_token for an access token (embed widget).
+    # 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. 
+    # @param client_id [String] The embed widget OAuth client_id.
+    # @param grant_type [String] Grant type.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :device_code The device code received from /oauth/device/authorize (required for device_code grant).
+    # @option opts [String] :refresh_token The refresh token (required for refresh_token grant).
+    # @return [nil]
+    def embed_oauth_token(client_id, grant_type, opts = {})
+      embed_oauth_token_with_http_info(client_id, grant_type, opts)
+      nil
+    end
+
+    # Exchange a device_code or refresh_token for an access token (embed widget).
+    # Accepts grant_type&#x3D;urn:ietf:params:oauth:grant-type:device_code or grant_type&#x3D;refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes. 
+    # @param client_id [String] The embed widget OAuth client_id.
+    # @param grant_type [String] Grant type.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :device_code The device code received from /oauth/device/authorize (required for device_code grant).
+    # @option opts [String] :refresh_token The refresh token (required for refresh_token grant).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def embed_oauth_token_with_http_info(client_id, grant_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationEmbedApi.embed_oauth_token ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling ConversationEmbedApi.embed_oauth_token"
+      end
+      # verify the required parameter 'grant_type' is set
+      if @api_client.config.client_side_validation && grant_type.nil?
+        fail ArgumentError, "Missing the required parameter 'grant_type' when calling ConversationEmbedApi.embed_oauth_token"
+      end
+      # resource path
+      local_var_path = '/conversation_embed/oauth/device/token'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['client_id'] = client_id
+      form_params['grant_type'] = grant_type
+      form_params['device_code'] = opts[:'device_code'] if !opts[:'device_code'].nil?
+      form_params['refresh_token'] = opts[:'refresh_token'] if !opts[:'refresh_token'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationEmbedApi.embed_oauth_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationEmbedApi#embed_oauth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get PBX authorization for the embedded softphone widget.
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationEmbedPbxAuthResponse]
+    def get_embed_pbx_auth(opts = {})
+      data, _status_code, _headers = get_embed_pbx_auth_with_http_info(opts)
+      data
+    end
+
+    # Get PBX authorization for the embedded softphone widget.
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEmbedPbxAuthResponse, Integer, Hash)>] ConversationEmbedPbxAuthResponse data, response status code and response headers
+    def get_embed_pbx_auth_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationEmbedApi.get_embed_pbx_auth ...'
+      end
+      # resource path
+      local_var_path = '/conversation_embed/pbx-auth'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationEmbedPbxAuthResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationEmbedApi.get_embed_pbx_auth",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationEmbedApi#get_embed_pbx_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ultracart_api/models/conversation_embed_pbx_auth_response.rb

@@ -0,0 +1,270 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationEmbedPbxAuthResponse
+    # Merchant identifier the agent belongs to.
+    attr_accessor :merchant_id
+
+    # True if this agent has PBX admin privileges.
+    attr_accessor :pbx_admin
+
+    # JWT used by the softphone widget to authenticate to the PBX WebSocket relay.
+    attr_accessor :pbx_jwt
+
+    # True if this agent has PBX supervisor privileges.
+    attr_accessor :pbx_supervisor
+
+    # True if this agent has baseline PBX access.
+    attr_accessor :pbx_user
+
+    # Voice identity string identifying this agent to the PBX (e.g., client:user_123).
+    attr_accessor :pbx_voice_identity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'merchant_id' => :'merchant_id',
+        :'pbx_admin' => :'pbx_admin',
+        :'pbx_jwt' => :'pbx_jwt',
+        :'pbx_supervisor' => :'pbx_supervisor',
+        :'pbx_user' => :'pbx_user',
+        :'pbx_voice_identity' => :'pbx_voice_identity'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'merchant_id' => :'String',
+        :'pbx_admin' => :'Boolean',
+        :'pbx_jwt' => :'String',
+        :'pbx_supervisor' => :'Boolean',
+        :'pbx_user' => :'Boolean',
+        :'pbx_voice_identity' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationEmbedPbxAuthResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationEmbedPbxAuthResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'pbx_admin')
+        self.pbx_admin = attributes[:'pbx_admin']
+      end
+
+      if attributes.key?(:'pbx_jwt')
+        self.pbx_jwt = attributes[:'pbx_jwt']
+      end
+
+      if attributes.key?(:'pbx_supervisor')
+        self.pbx_supervisor = attributes[:'pbx_supervisor']
+      end
+
+      if attributes.key?(:'pbx_user')
+        self.pbx_user = attributes[:'pbx_user']
+      end
+
+      if attributes.key?(:'pbx_voice_identity')
+        self.pbx_voice_identity = attributes[:'pbx_voice_identity']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          merchant_id == o.merchant_id &&
+          pbx_admin == o.pbx_admin &&
+          pbx_jwt == o.pbx_jwt &&
+          pbx_supervisor == o.pbx_supervisor &&
+          pbx_user == o.pbx_user &&
+          pbx_voice_identity == o.pbx_voice_identity
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [merchant_id, pbx_admin, pbx_jwt, pbx_supervisor, pbx_user, pbx_voice_identity].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.74'
+  VERSION = '4.1.77'
 end

data/lib/ultracart_api.rb

@@ -168,6 +168,7 @@ require 'ultracart_api/models/conversation_department_member'
 require 'ultracart_api/models/conversation_department_members_response'
 require 'ultracart_api/models/conversation_department_response'
 require 'ultracart_api/models/conversation_departments_response'
+require 'ultracart_api/models/conversation_embed_pbx_auth_response'
 require 'ultracart_api/models/conversation_engagement'
 require 'ultracart_api/models/conversation_engagement_equation'
 require 'ultracart_api/models/conversation_engagement_equation_function'
@@ -977,6 +978,7 @@ require 'ultracart_api/api/auto_order_api'
 require 'ultracart_api/api/channel_partner_api'
 require 'ultracart_api/api/checkout_api'
 require 'ultracart_api/api/conversation_api'
+require 'ultracart_api/api/conversation_embed_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
 require 'ultracart_api/api/datawarehouse_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.74
+  version: 4.1.77
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-15 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -217,6 +217,8 @@ files:
 - docs/ConversationDepartmentMembersResponse.md
 - docs/ConversationDepartmentResponse.md
 - docs/ConversationDepartmentsResponse.md
+- docs/ConversationEmbedApi.md
+- docs/ConversationEmbedPbxAuthResponse.md
 - docs/ConversationEngagement.md
 - docs/ConversationEngagementEquation.md
 - docs/ConversationEngagementEquationFunction.md
@@ -1041,6 +1043,7 @@ files:
 - lib/ultracart_api/api/channel_partner_api.rb
 - lib/ultracart_api/api/checkout_api.rb
 - lib/ultracart_api/api/conversation_api.rb
+- lib/ultracart_api/api/conversation_embed_api.rb
 - lib/ultracart_api/api/coupon_api.rb
 - lib/ultracart_api/api/customer_api.rb
 - lib/ultracart_api/api/datawarehouse_api.rb
@@ -1210,6 +1213,7 @@ files:
 - lib/ultracart_api/models/conversation_department_members_response.rb
 - lib/ultracart_api/models/conversation_department_response.rb
 - lib/ultracart_api/models/conversation_departments_response.rb
+- lib/ultracart_api/models/conversation_embed_pbx_auth_response.rb
 - lib/ultracart_api/models/conversation_engagement.rb
 - lib/ultracart_api/models/conversation_engagement_equation.rb
 - lib/ultracart_api/models/conversation_engagement_equation_function.rb