ultracart_rest_api_v2_typescript 4.0.226 → 4.0.228

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.226
+## ultracart_rest_api_v2_typescript@4.0.228
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.226 --save
+npm install ultracart_rest_api_v2_typescript@4.0.228 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.228 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
+| 4.0.227 | 06/03/2024 | conversationPbxPhoneNumber - fix serialized name for phone number UUID |
 | 4.0.226 | 05/31/2024 | ItemApi.getInventorySnapshot method |
 | 4.0.225 | 05/30/2024 | add adult sig req. to the merchant item destination markup for items |
 | 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |

package/dist/apis/ItemApi.d.ts

@@ -386,16 +386,16 @@ export interface ItemApiInterface {
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Retrieves a list of item inventories.
-     * @summary Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * @summary Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ItemApiInterface
      */
     restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
     /**
-     * Retrieves a list of item inventories.
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
     /**
@@ -653,13 +653,13 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Retrieves a list of item inventories.
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
     /**
-     * Retrieves a list of item inventories.
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
     /**

package/dist/apis/ItemApi.js

@@ -1164,8 +1164,8 @@ var ItemApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Retrieves a list of item inventories.
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     ItemApi.prototype.restItemInventorySnapshotResponseRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1202,8 +1202,8 @@ var ItemApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Retrieves a list of item inventories.
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     ItemApi.prototype.restItemInventorySnapshotResponse = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/models/ConversationPbxAgent.d.ts

@@ -27,12 +27,6 @@ export interface ConversationPbxAgent {
      * @memberof ConversationPbxAgent
      */
     conversation_pbx_agent_uuid?: string;
-    /**
-     * Conversation Pbx Voicemail Mailbox UUID
-     * @type {string}
-     * @memberof ConversationPbxAgent
-     */
-    conversation_pbx_voicemail_mailbox_uuid?: string;
     /**
      * Extension
      * @type {number}
@@ -63,12 +57,24 @@ export interface ConversationPbxAgent {
      * @memberof ConversationPbxAgent
      */
     merchant_id?: string;
+    /**
+     * Personal Conversation Pbx Voicemail Mailbox UUID
+     * @type {string}
+     * @memberof ConversationPbxAgent
+     */
+    personal_conversation_pbx_voicemail_mailbox_uuid?: string;
     /**
      * True if outgoing calls should be automatically recorded
      * @type {boolean}
      * @memberof ConversationPbxAgent
      */
     record_outgoing_automatically?: boolean;
+    /**
+     * Shared Conversation Pbx Voicemail Mailbox UUID
+     * @type {string}
+     * @memberof ConversationPbxAgent
+     */
+    shared_conversation_pbx_voicemail_mailbox_uuid?: string;
     /**
      * Twilio taskrouter worker Id
      * @type {string}

package/dist/models/ConversationPbxAgent.js

@@ -26,13 +26,14 @@ function ConversationPbxAgentFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'cellphone': !(0, runtime_1.exists)(json, 'cellphone') ? undefined : json['cellphone'],
         'conversation_pbx_agent_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_agent_uuid') ? undefined : json['conversation_pbx_agent_uuid'],
-        'conversation_pbx_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['conversation_pbx_voicemail_mailbox_uuid'],
         'extension': !(0, runtime_1.exists)(json, 'extension') ? undefined : json['extension'],
         'forward_calls_to_cellphone': !(0, runtime_1.exists)(json, 'forward_calls_to_cellphone') ? undefined : json['forward_calls_to_cellphone'],
         'full_name': !(0, runtime_1.exists)(json, 'full_name') ? undefined : json['full_name'],
         'login': !(0, runtime_1.exists)(json, 'login') ? undefined : json['login'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'personal_conversation_pbx_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'personal_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['personal_conversation_pbx_voicemail_mailbox_uuid'],
         'record_outgoing_automatically': !(0, runtime_1.exists)(json, 'record_outgoing_automatically') ? undefined : json['record_outgoing_automatically'],
+        'shared_conversation_pbx_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'shared_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['shared_conversation_pbx_voicemail_mailbox_uuid'],
         'twilio_taskrouter_worker_id': !(0, runtime_1.exists)(json, 'twilio_taskrouter_worker_id') ? undefined : json['twilio_taskrouter_worker_id'],
         'unavailable_play_audio_uuid': !(0, runtime_1.exists)(json, 'unavailable_play_audio_uuid') ? undefined : json['unavailable_play_audio_uuid'],
         'unavailable_say': !(0, runtime_1.exists)(json, 'unavailable_say') ? undefined : json['unavailable_say'],
@@ -52,13 +53,14 @@ function ConversationPbxAgentToJSON(value) {
     return {
         'cellphone': value.cellphone,
         'conversation_pbx_agent_uuid': value.conversation_pbx_agent_uuid,
-        'conversation_pbx_voicemail_mailbox_uuid': value.conversation_pbx_voicemail_mailbox_uuid,
         'extension': value.extension,
         'forward_calls_to_cellphone': value.forward_calls_to_cellphone,
         'full_name': value.full_name,
         'login': value.login,
         'merchant_id': value.merchant_id,
+        'personal_conversation_pbx_voicemail_mailbox_uuid': value.personal_conversation_pbx_voicemail_mailbox_uuid,
         'record_outgoing_automatically': value.record_outgoing_automatically,
+        'shared_conversation_pbx_voicemail_mailbox_uuid': value.shared_conversation_pbx_voicemail_mailbox_uuid,
         'twilio_taskrouter_worker_id': value.twilio_taskrouter_worker_id,
         'unavailable_play_audio_uuid': value.unavailable_play_audio_uuid,
         'unavailable_say': value.unavailable_say,

package/dist/models/ConversationPbxPhoneNumber.d.ts

@@ -32,7 +32,7 @@ export interface ConversationPbxPhoneNumber {
      * @type {string}
      * @memberof ConversationPbxPhoneNumber
      */
-    conversation_pbx_time_range_uuid?: string;
+    conversation_pbx_phone_number_uuid?: string;
     /**
      * Merchant Id
      * @type {string}

package/dist/models/ConversationPbxPhoneNumber.js

@@ -36,7 +36,7 @@ function ConversationPbxPhoneNumberFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'action': !(0, runtime_1.exists)(json, 'action') ? undefined : json['action'],
         'action_target': !(0, runtime_1.exists)(json, 'action_target') ? undefined : json['action_target'],
-        'conversation_pbx_time_range_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_time_range_uuid') ? undefined : json['conversation_pbx_time_range_uuid'],
+        'conversation_pbx_phone_number_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_phone_number_uuid') ? undefined : json['conversation_pbx_phone_number_uuid'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
         'phone_number': !(0, runtime_1.exists)(json, 'phone_number') ? undefined : json['phone_number'],
     };
@@ -52,7 +52,7 @@ function ConversationPbxPhoneNumberToJSON(value) {
     return {
         'action': value.action,
         'action_target': value.action_target,
-        'conversation_pbx_time_range_uuid': value.conversation_pbx_time_range_uuid,
+        'conversation_pbx_phone_number_uuid': value.conversation_pbx_phone_number_uuid,
         'merchant_id': value.merchant_id,
         'phone_number': value.phone_number,
     };

package/dist/models/ItemAutoOrderStep.d.ts

@@ -102,13 +102,13 @@ export interface ItemAutoOrderStep {
      */
     schedule?: string;
     /**
-     * Email list name to subscribe the customer to when the rebill occurs
+     * Email list name to subscribe the customer to when the rebill occurs (decommissioned email engine)
      * @type {string}
      * @memberof ItemAutoOrderStep
      */
     subscribe_email_list_name?: string;
     /**
-     * Email list identifier to subscribe the customer to when this rebill occurs
+     * Email list identifier to subscribe the customer to when this rebill occurs (decommissioned email engine)
      * @type {number}
      * @memberof ItemAutoOrderStep
      */

package/dist/models/ItemReporting.d.ts

@@ -22,7 +22,7 @@ export interface ItemReporting {
      */
     report_as_upsell?: boolean;
     /**
-     * Report pickable quantities
+     * Report pickable quantities (deprecated)
      * @type {Array<number>}
      * @memberof ItemReporting
      */

package/package.json

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

package/src/apis/ItemApi.ts

@@ -493,8 +493,8 @@ export interface ItemApiInterface {
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * Retrieves a list of item inventories. 
-     * @summary Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * @summary Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ItemApiInterface
@@ -502,8 +502,8 @@ export interface ItemApiInterface {
     restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
 
     /**
-     * Retrieves a list of item inventories. 
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
 
@@ -1417,8 +1417,8 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
     }
 
     /**
-     * Retrieves a list of item inventories. 
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     async restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>> {
         const queryParameters: any = {};
@@ -1445,8 +1445,8 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
     }
 
     /**
-     * Retrieves a list of item inventories. 
-     * Retrieve a list of item inventories
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
      */
     async restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse> {
         const response = await this.restItemInventorySnapshotResponseRaw(initOverrides);

package/src/models/ConversationPbxAgent.ts

@@ -31,12 +31,6 @@ export interface ConversationPbxAgent {
      * @memberof ConversationPbxAgent
      */
     conversation_pbx_agent_uuid?: string;
-    /**
-     * Conversation Pbx Voicemail Mailbox UUID
-     * @type {string}
-     * @memberof ConversationPbxAgent
-     */
-    conversation_pbx_voicemail_mailbox_uuid?: string;
     /**
      * Extension
      * @type {number}
@@ -67,12 +61,24 @@ export interface ConversationPbxAgent {
      * @memberof ConversationPbxAgent
      */
     merchant_id?: string;
+    /**
+     * Personal Conversation Pbx Voicemail Mailbox UUID
+     * @type {string}
+     * @memberof ConversationPbxAgent
+     */
+    personal_conversation_pbx_voicemail_mailbox_uuid?: string;
     /**
      * True if outgoing calls should be automatically recorded
      * @type {boolean}
      * @memberof ConversationPbxAgent
      */
     record_outgoing_automatically?: boolean;
+    /**
+     * Shared Conversation Pbx Voicemail Mailbox UUID
+     * @type {string}
+     * @memberof ConversationPbxAgent
+     */
+    shared_conversation_pbx_voicemail_mailbox_uuid?: string;
     /**
      * Twilio taskrouter worker Id
      * @type {string}
@@ -123,13 +129,14 @@ export function ConversationPbxAgentFromJSONTyped(json: any, ignoreDiscriminator
         
         'cellphone': !exists(json, 'cellphone') ? undefined : json['cellphone'],
         'conversation_pbx_agent_uuid': !exists(json, 'conversation_pbx_agent_uuid') ? undefined : json['conversation_pbx_agent_uuid'],
-        'conversation_pbx_voicemail_mailbox_uuid': !exists(json, 'conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['conversation_pbx_voicemail_mailbox_uuid'],
         'extension': !exists(json, 'extension') ? undefined : json['extension'],
         'forward_calls_to_cellphone': !exists(json, 'forward_calls_to_cellphone') ? undefined : json['forward_calls_to_cellphone'],
         'full_name': !exists(json, 'full_name') ? undefined : json['full_name'],
         'login': !exists(json, 'login') ? undefined : json['login'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'personal_conversation_pbx_voicemail_mailbox_uuid': !exists(json, 'personal_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['personal_conversation_pbx_voicemail_mailbox_uuid'],
         'record_outgoing_automatically': !exists(json, 'record_outgoing_automatically') ? undefined : json['record_outgoing_automatically'],
+        'shared_conversation_pbx_voicemail_mailbox_uuid': !exists(json, 'shared_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['shared_conversation_pbx_voicemail_mailbox_uuid'],
         'twilio_taskrouter_worker_id': !exists(json, 'twilio_taskrouter_worker_id') ? undefined : json['twilio_taskrouter_worker_id'],
         'unavailable_play_audio_uuid': !exists(json, 'unavailable_play_audio_uuid') ? undefined : json['unavailable_play_audio_uuid'],
         'unavailable_say': !exists(json, 'unavailable_say') ? undefined : json['unavailable_say'],
@@ -150,13 +157,14 @@ export function ConversationPbxAgentToJSON(value?: ConversationPbxAgent | null):
         
         'cellphone': value.cellphone,
         'conversation_pbx_agent_uuid': value.conversation_pbx_agent_uuid,
-        'conversation_pbx_voicemail_mailbox_uuid': value.conversation_pbx_voicemail_mailbox_uuid,
         'extension': value.extension,
         'forward_calls_to_cellphone': value.forward_calls_to_cellphone,
         'full_name': value.full_name,
         'login': value.login,
         'merchant_id': value.merchant_id,
+        'personal_conversation_pbx_voicemail_mailbox_uuid': value.personal_conversation_pbx_voicemail_mailbox_uuid,
         'record_outgoing_automatically': value.record_outgoing_automatically,
+        'shared_conversation_pbx_voicemail_mailbox_uuid': value.shared_conversation_pbx_voicemail_mailbox_uuid,
         'twilio_taskrouter_worker_id': value.twilio_taskrouter_worker_id,
         'unavailable_play_audio_uuid': value.unavailable_play_audio_uuid,
         'unavailable_say': value.unavailable_say,

package/src/models/ConversationPbxPhoneNumber.ts

@@ -36,7 +36,7 @@ export interface ConversationPbxPhoneNumber {
      * @type {string}
      * @memberof ConversationPbxPhoneNumber
      */
-    conversation_pbx_time_range_uuid?: string;
+    conversation_pbx_phone_number_uuid?: string;
     /**
      * Merchant Id
      * @type {string}
@@ -77,7 +77,7 @@ export function ConversationPbxPhoneNumberFromJSONTyped(json: any, ignoreDiscrim
         
         'action': !exists(json, 'action') ? undefined : json['action'],
         'action_target': !exists(json, 'action_target') ? undefined : json['action_target'],
-        'conversation_pbx_time_range_uuid': !exists(json, 'conversation_pbx_time_range_uuid') ? undefined : json['conversation_pbx_time_range_uuid'],
+        'conversation_pbx_phone_number_uuid': !exists(json, 'conversation_pbx_phone_number_uuid') ? undefined : json['conversation_pbx_phone_number_uuid'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
         'phone_number': !exists(json, 'phone_number') ? undefined : json['phone_number'],
     };
@@ -94,7 +94,7 @@ export function ConversationPbxPhoneNumberToJSON(value?: ConversationPbxPhoneNum
         
         'action': value.action,
         'action_target': value.action_target,
-        'conversation_pbx_time_range_uuid': value.conversation_pbx_time_range_uuid,
+        'conversation_pbx_phone_number_uuid': value.conversation_pbx_phone_number_uuid,
         'merchant_id': value.merchant_id,
         'phone_number': value.phone_number,
     };

package/src/models/ItemAutoOrderStep.ts

@@ -117,13 +117,13 @@ export interface ItemAutoOrderStep {
      */
     schedule?: string;
     /**
-     * Email list name to subscribe the customer to when the rebill occurs
+     * Email list name to subscribe the customer to when the rebill occurs (decommissioned email engine)
      * @type {string}
      * @memberof ItemAutoOrderStep
      */
     subscribe_email_list_name?: string;
     /**
-     * Email list identifier to subscribe the customer to when this rebill occurs
+     * Email list identifier to subscribe the customer to when this rebill occurs (decommissioned email engine)
      * @type {number}
      * @memberof ItemAutoOrderStep
      */

package/src/models/ItemReporting.ts

@@ -26,7 +26,7 @@ export interface ItemReporting {
      */
     report_as_upsell?: boolean;
     /**
-     * Report pickable quantities
+     * Report pickable quantities (deprecated)
      * @type {Array<number>}
      * @memberof ItemReporting
      */