ultracart_rest_api_v2_typescript 4.1.73 → 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
@@ -52,6 +53,7 @@ src/models/AutoOrderAddonItemOption.ts
 src/models/AutoOrderAddonItemsUpdateRequest.ts
 src/models/AutoOrderConsolidate.ts
 src/models/AutoOrderItem.ts
+src/models/AutoOrderItemCancelRequest.ts
 src/models/AutoOrderItemFutureSchedule.ts
 src/models/AutoOrderItemOption.ts
 src/models/AutoOrderItemSimpleSchedule.ts
@@ -174,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.73
+## 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.73 --save
+npm install ultracart_rest_api_v2_typescript@4.1.76 --save
 ```
 
 ```typescript
@@ -85,6 +85,9 @@ 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 |
 | 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |

package/dist/apis/AutoOrderApi.d.ts

@@ -10,7 +10,13 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
+import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
+export interface CancelAutoOrderItemByReferenceOrderIdRequest {
+    referenceOrderId: string;
+    originalItemId: string;
+    expand?: string;
+    autoOrderItemCancelRequest?: AutoOrderItemCancelRequest;
+}
 export interface ConsolidateAutoOrdersRequest {
     autoOrderOid: number;
     autoOrderConsolidate: AutoOrderConsolidate;
@@ -109,6 +115,23 @@ export interface UpdateAutoOrdersBatchRequest {
  * @interface AutoOrderApiInterface
  */
 export interface AutoOrderApiInterface {
+    /**
+     * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id.  The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion.
+     * @summary Cancel a single item on an auto order
+     * @param {string} referenceOrderId The reference order id (original_order_id) of the auto order.
+     * @param {string} originalItemId The original_item_id (SKU) of the item to cancel.
+     * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {AutoOrderItemCancelRequest} [autoOrderItemCancelRequest] Cancel request.  Body is optional; omit for default mode=end.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutoOrderApiInterface
+     */
+    cancelAutoOrderItemByReferenceOrderIdRaw(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+    /**
+     * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id.  The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion.
+     * Cancel a single item on an auto order
+     */
+    cancelAutoOrderItemByReferenceOrderId(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
      * Consolidates mutliple auto orders on the UltraCart account.
      * @summary Consolidates multiple auto orders
@@ -359,6 +382,16 @@ export interface AutoOrderApiInterface {
  *
  */
 export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterface {
+    /**
+     * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id.  The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion.
+     * Cancel a single item on an auto order
+     */
+    cancelAutoOrderItemByReferenceOrderIdRaw(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+    /**
+     * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id.  The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion.
+     * Cancel a single item on an auto order
+     */
+    cancelAutoOrderItemByReferenceOrderId(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
      * Consolidates mutliple auto orders on the UltraCart account.
      * Consolidates multiple auto orders

package/dist/apis/AutoOrderApi.js

@@ -75,6 +75,73 @@ var AutoOrderApi = /** @class */ (function (_super) {
     function AutoOrderApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id.  The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion.
+     * Cancel a single item on an auto order
+     */
+    AutoOrderApi.prototype.cancelAutoOrderItemByReferenceOrderIdRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.referenceOrderId === null || requestParameters.referenceOrderId === undefined) {
+                            throw new runtime.RequiredError('referenceOrderId', 'Required parameter requestParameters.referenceOrderId was null or undefined when calling cancelAutoOrderItemByReferenceOrderId.');
+                        }
+                        if (requestParameters.originalItemId === null || requestParameters.originalItemId === undefined) {
+                            throw new runtime.RequiredError('originalItemId', 'Required parameter requestParameters.originalItemId was null or undefined when calling cancelAutoOrderItemByReferenceOrderId.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel".replace("{".concat("reference_order_id", "}"), encodeURIComponent(String(requestParameters.referenceOrderId))).replace("{".concat("original_item_id", "}"), encodeURIComponent(String(requestParameters.originalItemId))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.AutoOrderItemCancelRequestToJSON)(requestParameters.autoOrderItemCancelRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id.  The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion.
+     * Cancel a single item on an auto order
+     */
+    AutoOrderApi.prototype.cancelAutoOrderItemByReferenceOrderId = function (requestParameters, 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.cancelAutoOrderItemByReferenceOrderIdRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Consolidates mutliple auto orders on the UltraCart account.
      * Consolidates multiple auto orders

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>;
+}